{"id":13598,"date":"2017-06-27T16:52:55","date_gmt":"2017-06-27T13:52:55","guid":{"rendered":"https:\/\/belvg.com\/blog\/?p=13598"},"modified":"2025-02-11T10:43:15","modified_gmt":"2025-02-11T08:43:15","slug":"collecting-xml-theme-files-in-magento-2","status":"publish","type":"post","link":"https:\/\/belvg.com\/blog\/collecting-xml-theme-files-in-magento-2.html","title":{"rendered":"Collecting XML Theme Files in Magento 2"},"content":{"rendered":"\n

In order to get onto the issue, let’s have a look at the method loadFileLayoutUpdatesXml()<\/em> of the class <\/span>Magento\\Framework\\View\\Model\\Layout\\Merge<\/em>. <\/span><\/p>\n

<\/p>\n

\/**\r\n\t* Collect and merge layout updates from files\r\n\t*\r\n\t* @return \\Magento\\Framework\\View\\Layout\\Element\r\n\t* @throws \\Magento\\Framework\\Exception\\LocalizedException\r\n\t*\/\r\n\tprotected function _loadFileLayoutUpdatesXml()\r\n\t{\r\n       $layoutStr = '';\r\n   \t$theme = $this->_getPhysicalTheme($this->theme);\r\n\t...\r\n<\/pre>\n
As for me, I use Magento 2.1.7, so in the picture, we can see the variable $theme<\/em> that contains theme data. In my case, there are data concerning default theme “Magento Luma”.<\/span><\/p>\n
\"Collecting<\/a><\/p>\n
$updateFiles = $this->fileSource->getFiles($theme, '*.xml');\r\n<\/pre>\n
\"Igor
Partner With Us <\/h3>Let's discuss how to grow your business. Get a Free Quote.<\/span><\/div> Talk to Igor<\/a><\/div>\n
On the stage, we get all XML files with the help of the method getFiles<\/em> placed in the class <\/span>\\lib\\internal\\Magento\\Framework\\View\\Layout\\File\\Collector\\Aggregated<\/em>. Let’s have a closer look at the method to comprehend how it works.<\/span><\/p>\n
\/**\r\n* Retrieve files\r\n*\r\n* Aggregate layout files from modules and a theme and its ancestors\r\n*\r\n* @param ThemeInterface $theme\r\n* @param string $filePath\r\n* @return \\Magento\\Framework\\View\\File[]\r\n*\/\r\npublic function getFiles(ThemeInterface $theme, $filePath)\r\n{\r\n    $list = $this->fileListFactory->create();\r\n       $list->add($this->baseFiles->getFiles($theme, $filePath));\r\n    foreach ($theme->getInheritedThemes() as $currentTheme) {\r\n           $list->add($this->themeFiles->getFiles($currentTheme, $filePath));\r\n           $list->replace($this->overrideBaseFiles->getFiles($currentTheme, $filePath));\r\n           $list->replace($this->overrideThemeFiles->getFiles($currentTheme, $filePath));\r\n    }\r\n    return $list->getAll();\r\n}<\/pre>\n
Here we create a list where pathways should be added to XML files. As before, it’s not clear where Magento finds XML files. Let’s define what is the method <\/span>getFiles<\/em> of the class<\/span> \/<\/span><\/em>lib\/internal\/Magento\/Framework\/View\/File\/Collector\/Decorator\/ModuleDependency<\/em> makes:<\/span><\/p>\n
\/**\r\n* Retrieve view files, sorted by the priority of modules they belong to\r\n*\r\n* @param ThemeInterface $theme\r\n* @param string $filePath\r\n* @return \\Magento\\Framework\\View\\File[]\r\n*\/\r\npublic function getFiles(ThemeInterface $theme, $filePath)\r\n{\r\n    $result = $this->subject->getFiles($theme, $filePath);\r\n       usort($result, [$this, 'compareFiles']);\r\n    return $result;\r\n}<\/pre>\n
As you can see, the method is considered as significant and simple. So we should learn one more method getFiles<\/em> of the class <\/span>\/lib\/internal\/Magento\/Framework\/View\/File\/Collector\/Decorator\/ModuleOutput<\/em>:<\/span><\/p>\n
\/**\r\n* Retrieve files\r\n*\r\n* Filter out theme files that belong to inactive modules or ones explicitly configured to not produce any output\r\n*\r\n* @param ThemeInterface $theme\r\n* @param string $filePath\r\n* @return \\Magento\\Framework\\View\\File[]\r\n*\/\r\npublic function getFiles(ThemeInterface $theme, $filePath)\r\n{\r\n    $result = [];\r\n    foreach ($this->subject->getFiles($theme, $filePath) as $file) {\r\n        if ($this->moduleManager->isOutputEnabled($file->getModule())) {\r\n            $result[] = $file;\r\n        }\r\n    }\r\n    return $result;\r\n}<\/pre>\n
<\/a>
Magento 2 Development<\/h3>
Take your online store to the next level with BelVG Magento 2 Development<\/p>Visit the page<\/span><\/a><\/div><\/div><\/div>\n
As it is mentioned in the code, from the list of all modules we leave only active. Let’s continue reviewing the method getFiles<\/em> of the class <\/span>Magento\/Framework\/View\/File\/Collector\/Base<\/em>:<\/span><\/p>\n
\/**\r\n* Retrieve files\r\n*\r\n* @param \\Magento\\Framework\\View\\Design\\ThemeInterface $theme\r\n* @param string $filePath\r\n* @return \\Magento\\Framework\\View\\File[]\r\n*\/\r\npublic function getFiles(ThemeInterface $theme, $filePath)\r\n{\r\n    $result = [];\r\n       $sharedFiles = $this->componentDirSearch->collectFilesWithContext(\r\n        ComponentRegistrar::MODULE,\r\n           \"view\/base\/{$this->subDir}{$filePath}\"\r\n    );\r\n    foreach ($sharedFiles as $file) {\r\n           $result[] = $this->fileFactory->create($file->getFullPath(), $file->getComponentName(), null, true);\r\n    }\r\n    $area = $theme->getData('area');\r\n       $themeFiles = $this->componentDirSearch->collectFilesWithContext(\r\n           ComponentRegistrar::MODULE,\r\n           \"view\/{$area}\/{$this->subDir}{$filePath}\"\r\n    );\r\n    foreach ($themeFiles as $file) {\r\n           $result[] = $this->fileFactory->create($file->getFullPath(), $file->getComponentName());\r\n    }\r\n    return $result;\r\n}<\/pre>\n
Here we can find something interesting. Let’s learn how XML files are collected:<\/span><\/p>\n
...\r\n$sharedFiles = $this->componentDirSearch->collectFilesWithContext(\r\n           ComponentRegistrar::MODULE,\r\n           \"view\/base\/{$this->subDir}{$filePath}\"\r\n    );\r\n…\r\n$area = $theme->getData('area');\r\n       $themeFiles = $this->componentDirSearch->collectFilesWithContext(\r\n           ComponentRegistrar::MODULE,\r\n           \"view\/{$area}\/{$this->subDir}{$filePath}\"\r\n    );\r\n...<\/pre>\n
Where:<\/span><\/p>\n
$area – frontend
\n$this->subDir – ui_componen\/
\n$filePath – etc\/definition.xml<\/p>\n
First of all, we get the XML file of the pathway <\/span>“view\/base\/ui_componen\/etc\/definition.xml”. Then it’s necessary to get the XML file of the pathway “view\/frontend\/ui_componen\/etc\/definition.xml”.<\/span><\/p>\n
The method collectFilesWithContext<\/em> of the class Magento\\Framework\\Component\\DirSearch<\/em> gets the list of files in the definite directory back. Even a needed file can be given back, as in our case. <\/span>As a result, we have “view\/base\/ui_component\/etc\/definition.xml” file in $sharedFiles<\/em> array. While $themeFiles<\/em> array is empty, as the file has not been created on the way. Therefore, we get a file where all UI components have a base declaration.<\/span><\/p>\n
<\/a>
\"magento
Magento Webdesign<\/h3>
Take your online store to the next level with BelVG Magento webdesign<\/p>Visit the page<\/span><\/a><\/div><\/div><\/div>\n
It’s high time to return to the method _loadFileLayoutUpdatesXml<\/em> we started with. The following line is in it:<\/span><\/p>\n
...\r\n$updateFiles = array_merge($updateFiles, $this->pageLayoutFileSource->getFiles($theme, '*.xml'));\r\n...<\/pre>\n
Since we know the whole pathway consisting of some getFiles methods, let’s jump of Magento\/Framework\/View\/File\/Collector\/Base::getFiles<\/em><\/span><\/p>\n
Now we get XML of not a definite XML file, but all XML files in the directory “view\/base\/layout\/”.<\/span><\/p>\n
Let’s have a look at the screenshots and define what is contained in $sharedFiles:<\/span><\/p>\n
\"Collecting<\/a><\/p>\n
As a result, we get XML files of the directory “view\/frontend\/layout\/”. <\/span>Let’s look at the second screenshot and define what is contained in $themeFiles<\/em>:<\/span><\/p>\n
\"Collecting<\/a><\/p>\n
We have all xml files of the theme. Let’s summarize which files we’ve got for further processing:<\/span><\/p>\n