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

dmitrii_fediuk (Dmitrii Fediuk) April 6, 2016, 1:42am 1

Context: How is a layout built?

github.com

magento/magento2/blob/1464a2c/lib/internal/Magento/Framework/View/Model/Layout/Merge.php#L670-L679


/**
 * Collect and merge layout updates from files
 *
 * @return \Magento\Framework\View\Layout\Element
 * @throws \Magento\Framework\Exception\LocalizedException
 */
protected function _loadFileLayoutUpdatesXml()
{
    $layoutStr = '';
    $theme = $this->_getPhysicalTheme($this->theme);

github.com

magento/magento2/blob/1464a2c/lib/internal/Magento/Framework/View/Model/Layout/Merge.php#L680-L680


$updateFiles = $this->fileSource->getFiles($theme, '*.xml');

github.com

magento/magento2/blob/1464a2c/lib/internal/Magento/Framework/View/Layout/File/Collector/Aggregated.php#L76-L88


/**
 * Retrieve files
 *
 * Aggregate layout files from modules and a theme and its ancestors
 *
 * @param ThemeInterface $theme
 * @param string $filePath
 * @return \Magento\Framework\View\File[]
 */
public function getFiles(ThemeInterface $theme, $filePath)
{
    $list = $this->fileListFactory->create();
    $list->add($this->baseFiles->getFiles($theme, $filePath));

github.com

magento/magento2/blob/1464a2c/lib/internal/Magento/Framework/View/File/Collector/Decorator/ModuleDependency.php#L54-L63


/**
 * Retrieve view files, sorted by the priority of modules they belong to
 *
 * @param ThemeInterface $theme
 * @param string $filePath
 * @return \Magento\Framework\View\File[]
 */
public function getFiles(ThemeInterface $theme, $filePath)
{
    $result = $this->subject->getFiles($theme, $filePath);

github.com

magento/magento2/blob/1464a2c/lib/internal/Magento/Framework/View/File/Collector/Decorator/ModuleOutput.php#L47-L59


/**
 * Retrieve files
 *
 * Filter out theme files that belong to inactive modules or ones explicitly configured to not produce any output
 *
 * @param ThemeInterface $theme
 * @param string $filePath
 * @return \Magento\Framework\View\File[]
 */
public function getFiles(ThemeInterface $theme, $filePath)
{
    $result = [];
    foreach ($this->subject->getFiles($theme, $filePath) as $file) {

github.com

magento/magento2/blob/1464a2c/lib/internal/Magento/Framework/View/File/Collector/Base.php#L51-L64


/**
 * Retrieve files
 *
 * @param \Magento\Framework\View\Design\ThemeInterface $theme
 * @param string $filePath
 * @return \Magento\Framework\View\File[]
 */
public function getFiles(ThemeInterface $theme, $filePath)
{
    $result = [];
    $sharedFiles = $this->componentDirSearch->collectFilesWithContext(
        ComponentRegistrar::MODULE,
        "view/base/{$this->subDir}{$filePath}"
    );

github.com

magento/magento2/blob/1464a2c/lib/internal/Magento/Framework/Component/DirSearch.php#L53-L63


/**
 * Search for files in each component by pattern, returns file objects with absolute file paths
 *
 * @param string $componentType
 * @param string $pattern
 * @return ComponentFile[]
 */
public function collectFilesWithContext($componentType, $pattern)
{
    return $this->collect($componentType, $pattern, true);
}

github.com

magento/magento2/blob/1464a2c/lib/internal/Magento/Framework/View/File/Collector/Base.php#L65-L67


foreach ($sharedFiles as $file) {
    $result[] = $this->fileFactory->create($file->getFullPath(), $file->getComponentName(), null, true);
}

github.com

magento/magento2/blob/1464a2c/lib/internal/Magento/Framework/View/File/Collector/Base.php#L68-L72


$area = $theme->getData('area');
$themeFiles = $this->componentDirSearch->collectFilesWithContext(
    ComponentRegistrar::MODULE,
    "view/{$area}/{$this->subDir}{$filePath}"
);

github.com

magento/magento2/blob/1464a2c/lib/internal/Magento/Framework/View/File/Collector/Base.php#L73-L76


foreach ($themeFiles as $file) {
    $result[] = $this->fileFactory->create($file->getFullPath(), $file->getComponentName());
}
return $result;

github.com

magento/magento2/blob/1464a2c/lib/internal/Magento/Framework/View/File/Collector/Decorator/ModuleOutput.php#L60-L64


    if ($this->moduleManager->isOutputEnabled($file->getModule())) {
        $result[] = $file;
    }
}
return $result;

github.com

magento/magento2/blob/1464a2c/lib/internal/Magento/Framework/View/File/Collector/Decorator/ModuleDependency.php#L64-L64


usort($result, [$this, 'compareFiles']);

github.com

magento/magento2/blob/1464a2c/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);
}

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

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

How is a layout built?

dmitrii_fediuk (Dmitrii Fediuk) April 6, 2016, 1:42am 2

See also:

How is a page rendered?