How is the \Magento\Framework\View\File\Collector\Decorator\ModuleDependency::getModulePriority() implemented and used?

dmitry_fedyuk · April 8, 2016, 10:31pm

Implementation

magento/magento2/blob/ec436ce/lib/internal/Magento/Framework/View/File/Collector/Decorator/ModuleDependency.php#L88-L105


/**
 * Retrieve priority of a module relatively to other modules in the system
 *
 * @param string $moduleName
 * @return int
 */
protected function getModulePriority($moduleName)
{
    if ($this->orderedModules === null) {
        $this->orderedModules = $this->moduleList->getNames();
    }
    $result = array_search($moduleName, $this->orderedModules);
    // Assume unknown modules have the same priority, distinctive from known modules
    if ($result === false) {
        return -1;
    }
    return $result;
}

The sole usage

github.com

magento/magento2/blob/ec436ce/lib/internal/Magento/Framework/View/File/Collector/Decorator/ModuleDependency.php#L68-L86


/**
 * Compare view files according to the priority of modules they belong to. To be used as a callback for sorting.
 *
 * @param File $fileOne
 * @param File $fileTwo
 * @return int
 */
public function compareFiles(File $fileOne, File $fileTwo)
{
    if ($fileOne->getModule() == $fileTwo->getModule()) {
        return strcmp($fileOne->getName(), $fileTwo->getName());
    }
    $moduleOnePriority = $this->getModulePriority($fileOne->getModule());
    $moduleTwoPriority = $this->getModulePriority($fileTwo->getModule());
    if ($moduleOnePriority == $moduleTwoPriority) {
        return strcmp($fileOne->getModule(), $fileTwo->getModule());
    }
    return ($moduleOnePriority < $moduleTwoPriority ? -1 : 1);
}

Context: How does \Magento\Framework\View\Model\Layout\Merge::_loadFileLayoutUpdatesXml() work?

Details

github.com

magento/magento2/blob/ec436ce/lib/internal/Magento/Framework/View/File/Collector/Decorator/ModuleDependency.php#L88-L94


/**
 * Retrieve priority of a module relatively to other modules in the system
 *
 * @param string $moduleName
 * @return int
 */
protected function getModulePriority($moduleName)

github.com

magento/magento2/blob/ec436ce/lib/internal/Magento/Framework/View/File/Collector/Decorator/ModuleDependency.php#L95-L98


{
    if ($this->orderedModules === null) {
        $this->orderedModules = $this->moduleList->getNames();
    }

github.com

magento/magento2/blob/ec436ce/lib/internal/Magento/Framework/Module/ModuleList.php#L96-L101


/**
 * {@inheritdoc}
 */
public function getNames()
{
    $this->loadConfigData();

Details: How are the app/etc/config.php and app/etc/env.php files loaded?

github.com

magento/magento2/blob/ec436ce/lib/internal/Magento/Framework/Module/ModuleList.php#L102-L107


    if (!$this->configData) {
        return [];
    }
    $result = array_keys(array_filter($this->configData));
    return $result;
}

github.com

magento/magento2/blob/ec436ce/lib/internal/Magento/Framework/View/File/Collector/Decorator/ModuleDependency.php#L99-L99


$result = array_search($moduleName, $this->orderedModules);

github.com

magento/magento2/blob/ec436ce/lib/internal/Magento/Framework/View/File/Collector/Decorator/ModuleDependency.php#L100-L105


    // Assume unknown modules have the same priority, distinctive from known modules
    if ($result === false) {
        return -1;
    }
    return $result;
}

dmitry_fedyuk · April 9, 2016, 5:41am