Merge Class Reference

Inheritance diagram for Merge:

Public Member Functions
	__construct (\Magento\Framework\View\DesignInterface $design, \Magento\Framework\Url\ScopeResolverInterface $scopeResolver, \Magento\Framework\View\File\CollectorInterface $fileSource, \Magento\Framework\View\File\CollectorInterface $pageLayoutFileSource, \Magento\Framework\App\State $appState, \Magento\Framework\Cache\FrontendInterface $cache, \Magento\Framework\View\Model\Layout\Update\Validator $validator, \Psr\Log\LoggerInterface $logger, ReadFactory $readFactory, \Magento\Framework\View\Design\ThemeInterface $theme=null, $cacheSuffix='', LayoutCacheKeyInterface $layoutCacheKey=null)
	addUpdate ($update)
	asArray ()
	asString ()
	addHandle ($handleName)
	removeHandle ($handleName)
	getHandles ()
	addPageHandles (array $handlesToTry)
	pageHandleExists ($handleName)
	getPageLayout ()
	isLayoutDefined ()
	getPageHandles ()
	getPageHandleType ($handleName)
	load ($handles=[])
	asSimplexml ()
	validateUpdate ($handle, $updateXml)
	getDbUpdateString ($handle)
	getFileLayoutUpdatesXml ()
	__destruct ()
	isCustomerDesignAbstraction (array $abstraction)
	isPageLayoutDesignAbstraction (array $abstraction)
	getTheme ()
	getScope ()
	getCacheId ()
Public Member Functions inherited from ProcessorInterface
	getAllDesignAbstractions ()
	getContainers ()

Data Fields
const	DESIGN_ABSTRACTION_CUSTOM = 'custom'
const	DESIGN_ABSTRACTION_PAGE_LAYOUT = 'page_layout'
const	XPATH_HANDLE_DECLARATION = '/layout[@design_abstraction]'
const	TYPE_ATTRIBUTE = 'xsi:type'
const	PAGE_LAYOUT_CACHE_SUFFIX = 'page_layout'

Protected Member Functions
	_getPageHandleNode ($handleName)
	_validateMergedLayout ($cacheId, $layout)
	_loadXmlString ($xmlString)
	_merge ($handle)
	_fetchPackageLayoutUpdates ($handle)
	_fetchDbLayoutUpdates ($handle)
	_substitutePlaceholders ($xmlString)
	_fetchRecursiveUpdates ($updateXml)
	generateCacheId ($suffix='')
	_loadCache ($cacheId)
	_saveCache ($data, $cacheId, array $cacheTags=[])
	_logXmlErrors ($fileName, $xmlErrors)
	_getPhysicalTheme (\Magento\Framework\View\Design\ThemeInterface $theme)
	_renderXmlAttributes (\SimpleXMLElement $node)

Protected Attributes
	$layoutUpdatesCache
	$updates = []
	$handles = []
	$pageHandles = []
	$subst = null
	$cache
	$layoutValidator
	$logger
	$pageLayout
	$cacheSuffix
	$allHandles = []
	$handleProcessing = 1
	$handleProcessed = 2

Detailed Description

Layout merge model @SuppressWarnings(PHPMD.TooManyFields) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 20 of file Merge.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\View\DesignInterface	$design,
		\Magento\Framework\Url\ScopeResolverInterface	$scopeResolver,
		\Magento\Framework\View\File\CollectorInterface	$fileSource,
		\Magento\Framework\View\File\CollectorInterface	$pageLayoutFileSource,
		\Magento\Framework\App\State	$appState,
		\Magento\Framework\Cache\FrontendInterface	$cache,
		\Magento\Framework\View\Model\Layout\Update\Validator	$validator,
		\Psr\Log\LoggerInterface	$logger,
		ReadFactory	$readFactory,
		\Magento\Framework\View\Design\ThemeInterface	$theme = null,
			$cacheSuffix = '',
		LayoutCacheKeyInterface	$layoutCacheKey = null
	)

Init merge model

Parameters

\Magento\Framework\View\DesignInterface	$design
\Magento\Framework\Url\ScopeResolverInterface	$scopeResolver
\Magento\Framework\View\File\CollectorInterface	$fileSource
\Magento\Framework\View\File\CollectorInterface	$pageLayoutFileSource
\Magento\Framework\App\State	$appState
\Magento\Framework\Cache\FrontendInterface	$cache
\Magento\Framework\View\Model\Layout\Update\Validator	$validator
\Psr\Log\LoggerInterface	$logger
ReadFactory	$readFactory

Definition at line 182 of file Merge.php.

      {
        $this->theme = $theme ?: $design->getDesignTheme();
        $this->scope = $scopeResolver->getScope();
        $this->fileSource = $fileSource;
        $this->pageLayoutFileSource = $pageLayoutFileSource;
        $this->appState = $appState;
        $this->cache = $cache;
        $this->layoutValidator = $validator;
        $this->logger = $logger;
        $this->readFactory = $readFactory;
        $this->cacheSuffix = $cacheSuffix;
        $this->layoutCacheKey = $layoutCacheKey
            ?: \Magento\Framework\App\ObjectManager::getInstance()->get(LayoutCacheKeyInterface::class);
    }

__destruct()

__destruct

(

)

Cleanup circular references

Destructor should be called explicitly in order to work around the PHP bug https://bugs.php.net/bug.php?id=62468

Definition at line 877 of file Merge.php.

    {
        $this->updates = [];
        $this->layoutUpdatesCache = null;
    }

Member Function Documentation

_fetchDbLayoutUpdates()

_fetchDbLayoutUpdates (   $handle )

protected

Fetch & add layout updates for the specified handle from the database

Parameters

string

$handle

Returns

bool

Definition at line 568 of file Merge.php.

    {
        $_profilerKey = 'layout_db_update: ' . $handle;
        \Magento\Framework\Profiler::start($_profilerKey);
        $updateStr = $this->getDbUpdateString($handle);
        if (!$updateStr) {
            \Magento\Framework\Profiler::stop($_profilerKey);
            return false;
        }
        $updateStr = '<update_xml xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">' .
            $updateStr .
            '</update_xml>';
        $updateStr = $this->_substitutePlaceholders($updateStr);
        $updateXml = $this->_loadXmlString($updateStr);
        $this->_fetchRecursiveUpdates($updateXml);
        $updateInnerXml = $updateXml->innerXml();
        $this->validateUpdate($handle, $updateInnerXml);
        $this->addUpdate($updateInnerXml);

        \Magento\Framework\Profiler::stop($_profilerKey);
        return (bool)$updateStr;
    }

_fetchPackageLayoutUpdates()

_fetchPackageLayoutUpdates (   $handle )

protected

Add updates for the specified handle

Parameters

string

$handle

Returns

bool

Definition at line 546 of file Merge.php.

    {
        $_profilerKey = 'layout_package_update:' . $handle;
        \Magento\Framework\Profiler::start($_profilerKey);
        $layout = $this->getFileLayoutUpdatesXml();
        foreach ($layout->xpath("*[self::handle or self::layout][@id='{$handle}']") as $updateXml) {
            $this->_fetchRecursiveUpdates($updateXml);
            $updateInnerXml = $updateXml->innerXml();
            $this->validateUpdate($handle, $updateInnerXml);
            $this->addUpdate($updateInnerXml);
        }
        \Magento\Framework\Profiler::stop($_profilerKey);

        return true;
    }

_fetchRecursiveUpdates()

_fetchRecursiveUpdates (   $updateXml )

protected

Add handles declared as '<update handle="handle_name">' directives

Parameters

\SimpleXMLElement

$updateXml

Returns

$this

Definition at line 649 of file Merge.php.

    {
        foreach ($updateXml->children() as $child) {
            if (strtolower($child->getName()) == 'update' && isset($child['handle'])) {
                $this->_merge((string)$child['handle']);
            }
        }
        if (isset($updateXml['layout'])) {
            $this->pageLayout = (string)$updateXml['layout'];
        }
        return $this;
    }

_getPageHandleNode()

_getPageHandleNode (   $handleName )

protected

Get handle xml node by handle name

Parameters

string

$handleName

Returns

\Magento\Framework\View\Layout\Element|null

Definition at line 347 of file Merge.php.

    {
        /* quick validation for non-existing page types */
        if (!$handleName) {
            return null;
        }
        $handles = $this->getFileLayoutUpdatesXml()->xpath("handle[@id='{$handleName}']");
        if (empty($handles)) {
            return null;
        }
        $nodes = $this->getFileLayoutUpdatesXml()->xpath("/layouts/handle[@id=\"{$handleName}\"]");
        return $nodes ? reset($nodes) : null;
    }

_getPhysicalTheme()

_getPhysicalTheme ( \Magento\Framework\View\Design\ThemeInterface  $theme )

protected

Find the closest physical theme among ancestors and a theme itself

Parameters

\Magento\Framework\View\Design\ThemeInterface

$theme

Returns

\Magento\Theme\Model\Theme

Exceptions

Definition at line 814 of file Merge.php.

    {
        $result = $theme;
        while ($result !== null && $result->getId() && !$result->isPhysical()) {
            $result = $result->getParentTheme();
        }
        if (!$result) {
            throw new \Magento\Framework\Exception\LocalizedException(
                new \Magento\Framework\Phrase(
                    'Unable to find a physical ancestor for a theme \'%1\'.',
                    [$theme->getThemeTitle()]
                )
            );
        }
        return $result;
    }

_loadCache()

_loadCache (   $cacheId )

protected

Retrieve data from the cache, if the layout caching is allowed, or FALSE otherwise

Parameters

string

$cacheId

Returns

string|bool

Definition at line 701 of file Merge.php.

    {
        return $this->cache->load($cacheId);
    }

_loadXmlString()

_loadXmlString (   $xmlString )

protected

Return object representation of XML string

Parameters

string

$xmlString

Returns

\SimpleXMLElement

Definition at line 514 of file Merge.php.

    {
        return simplexml_load_string($xmlString, \Magento\Framework\View\Layout\Element::class);
    }

_logXmlErrors()

_logXmlErrors (   $fileName,   $xmlErrors  )

protected

Log xml errors to system log

Parameters

string	$fileName
array	$xmlErrors

Returns

void

Definition at line 783 of file Merge.php.

    {
        $this->logger->info(
            sprintf("Theme layout update file '%s' is not valid.\n%s", $fileName, implode("\n", $xmlErrors))
        );
    }

_merge()

_merge (   $handle )

protected

Merge layout update by handle

Parameters

string

$handle

Returns

$this

Definition at line 525 of file Merge.php.

    {
        if (!isset($this->allHandles[$handle])) {
            $this->allHandles[$handle] = $this->handleProcessing;
            $this->_fetchPackageLayoutUpdates($handle);
            $this->_fetchDbLayoutUpdates($handle);
            $this->allHandles[$handle] = $this->handleProcessed;
        } elseif ($this->allHandles[$handle] == $this->handleProcessing
            && $this->appState->getMode() === \Magento\Framework\App\State::MODE_DEVELOPER
        ) {
            $this->logger->info('Cyclic dependency in merged layout for handle: ' . $handle);
        }
        return $this;
    }

_renderXmlAttributes()

_renderXmlAttributes ( \SimpleXMLElement  $node )

protected

Return attributes of XML node rendered as a string

Parameters

\SimpleXMLElement

$node

Returns

string

Definition at line 837 of file Merge.php.

    {
        $result = '';
        foreach ($node->attributes() as $attributeName => $attributeValue) {
            $result .= ' ' . $attributeName . '="' . $attributeValue . '"';
        }
        return $result;
    }

_saveCache()

_saveCache (   $data,   $cacheId, array  $cacheTags = []  )

protected

Save data to the cache, if the layout caching is allowed

Parameters

string	$data
string	$cacheId
array	$cacheTags

Returns

void

Definition at line 714 of file Merge.php.

    {
        $this->cache->save($data, $cacheId, $cacheTags, null);
    }

_substitutePlaceholders()

_substitutePlaceholders (   $xmlString )

protected

Substitute placeholders {{placeholder_name}} with their values in XML string

Parameters

string

$xmlString

Returns

string

Definition at line 614 of file Merge.php.

    {
        if ($this->subst === null) {
            $placeholders = [
                'baseUrl' => $this->scope->getBaseUrl(),
                'baseSecureUrl' => $this->scope->getBaseUrl(\Magento\Framework\UrlInterface::URL_TYPE_LINK, true),
            ];
            $this->subst = [];
            foreach ($placeholders as $key => $value) {
                $this->subst['from'][] = '{{' . $key . '}}';
                $this->subst['to'][] = $value;
            }
        }
        return str_replace($this->subst['from'], $this->subst['to'], $xmlString);
    }

_validateMergedLayout()

_validateMergedLayout (   $cacheId,   $layout  )

protected

Validate merged layout

Parameters

string	$cacheId
string	$layout

Returns

$this

Exceptions

Definition at line 471 of file Merge.php.

    {
        $layoutStr = '<handle id="handle">' . $layout . '</handle>';

        try {
            $this->layoutValidator->isValid($layoutStr, Validator::LAYOUT_SCHEMA_MERGED, false);
        } catch (\Exception $e) {
            $messages = $this->layoutValidator->getMessages();
            //Add first message to exception
            $message = reset($messages);
            $this->logger->info(
                'Cache file with merged layout: ' . $cacheId
                . ' and handles ' . implode(', ', (array)$this->getHandles()) . ': ' . $message
            );
            if ($this->appState->getMode() === \Magento\Framework\App\State::MODE_DEVELOPER) {
                throw $e;
            }
        }

        return $this;
    }

addHandle()

addHandle

(

$handleName

)

Add handle(s) to update

Parameters

array | string

$handleName

Returns

$this

Implements ProcessorInterface.

Definition at line 250 of file Merge.php.

    {
        if (is_array($handleName)) {
            foreach ($handleName as $name) {
                $this->handles[$name] = 1;
            }
        } else {
            $this->handles[$handleName] = 1;
        }
        return $this;
    }

addPageHandles()

addPageHandles

(

array

$handlesToTry

)

Add the first existing (declared in layout updates) page handle along with all parents to the update. Return whether any page handles have been added or not.

Parameters

string[]

$handlesToTry

Returns

bool

Implements ProcessorInterface.

Definition at line 291 of file Merge.php.

    {
        $handlesAdded = false;
        foreach ($handlesToTry as $handleName) {
            if (!$this->pageHandleExists($handleName)) {
                continue;
            }
            $handles[] = $handleName;
            $this->pageHandles = $handles;
            $this->addHandle($handles);
            $handlesAdded = true;
        }
        return $handlesAdded;
    }

addUpdate()

addUpdate

(

$update

)

Add XML update instruction

Parameters

string

$update

Returns

$this

Implements ProcessorInterface.

Definition at line 216 of file Merge.php.

    {
        if (!in_array($update, $this->updates)) {
            $this->updates[] = $update;
        }
        return $this;
    }

asArray()

asArray

(

)

Get all registered updates as array

Returns

array

Implements ProcessorInterface.

Definition at line 229 of file Merge.php.

    {
        return $this->updates;
    }

asSimplexml()

asSimplexml

(

)

Get layout updates as \Magento\Framework\View\Layout\Element object

Returns

\SimpleXMLElement

Implements ProcessorInterface.

Definition at line 498 of file Merge.php.

    {
        $updates = trim($this->asString());
        $updates = '<?xml version="1.0"?>'
            . '<layout xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">'
            . $updates
            . '</layout>';
        return $this->_loadXmlString($updates);
    }

asString()

asString

(

)

Get all registered updates as string

Returns

string

Implements ProcessorInterface.

Definition at line 239 of file Merge.php.

    {
        return implode('', $this->updates);
    }

generateCacheId()

generateCacheId (   $suffix = '' )

protected

Generate cache identifier taking into account current area/package/theme/store

Parameters

string

$suffix

Returns

string

Definition at line 690 of file Merge.php.

    {
        return "LAYOUT_{$this->theme->getArea()}_STORE{$this->scope->getId()}_{$this->theme->getId()}{$suffix}";
    }

getCacheId()

getCacheId

(

)

Return cache ID based current area/package/theme/store and handles

Returns

string

Implements ProcessorInterface.

Definition at line 930 of file Merge.php.

    {
        $layoutCacheKeys = $this->layoutCacheKey->getCacheKeys();
        return $this->generateCacheId(md5(implode('|', array_merge($this->getHandles(), $layoutCacheKeys))));
    }

getDbUpdateString()

getDbUpdateString

(

$handle

)

Get update string

Parameters

string

$handle

Returns

string

@SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 638 of file Merge.php.

    {
        return null;
    }

getFileLayoutUpdatesXml()

getFileLayoutUpdatesXml

(

)

Retrieve already merged layout updates from files for specified area/theme/package/store

Returns

\Magento\Framework\View\Layout\Element

Implements ProcessorInterface.

Definition at line 667 of file Merge.php.

    {
        if ($this->layoutUpdatesCache) {
            return $this->layoutUpdatesCache;
        }
        $cacheId = $this->generateCacheId($this->cacheSuffix);
        $result = $this->_loadCache($cacheId);
        if ($result) {
            $result = $this->_loadXmlString($result);
        } else {
            $result = $this->_loadFileLayoutUpdatesXml();
            $this->_saveCache($result->asXML(), $cacheId);
        }
        $this->layoutUpdatesCache = $result;
        return $result;
    }

getHandles()

getHandles

(

)

Get handle names array

Returns

array

Implements ProcessorInterface.

Definition at line 279 of file Merge.php.

    {
        return array_keys($this->handles);
    }

getPageHandles()

getPageHandles

(

)

Retrieve used page handle names sorted from parent to child

Returns

array

Definition at line 366 of file Merge.php.

    {
        return $this->pageHandles;
    }

getPageHandleType()

getPageHandleType

(

$handleName

)

Retrieve the type of a page handle

Parameters

string

$handleName

Returns

string|null

Definition at line 415 of file Merge.php.

    {
        $node = $this->_getPageHandleNode($handleName);
        return $node ? $node->getAttribute('type') : null;
    }

getPageLayout()

getPageLayout

(

)

Returns

string|null

Definition at line 320 of file Merge.php.

    {
        return $this->pageLayout;
    }

getScope()

getScope

(

)

Retrieve current scope

Returns

\Magento\Framework\Url\ScopeInterface

Definition at line 920 of file Merge.php.

    {
        return $this->scope;
    }

getTheme()

getTheme

(

)

Retrieve theme

Returns

\Magento\Framework\View\Design\ThemeInterface

Definition at line 910 of file Merge.php.

    {
        return $this->theme;
    }

isCustomerDesignAbstraction()

isCustomerDesignAbstraction

(

array

$abstraction

)

Check custom design abstractions that exist in the system

Parameters

array

$abstraction

Returns

bool

Implements ProcessorInterface.

Definition at line 886 of file Merge.php.

    {
        if (!isset($abstraction['design_abstraction'])) {
            return false;
        }
        return $abstraction['design_abstraction'] === self::DESIGN_ABSTRACTION_CUSTOM;
    }

isLayoutDefined()

isLayoutDefined

(

)

Check current handles if layout was defined on it

Returns

bool

Definition at line 330 of file Merge.php.

    {
        $fullLayoutXml = $this->getFileLayoutUpdatesXml();
        foreach ($this->getHandles() as $handle) {
            if ($fullLayoutXml->xpath("layout[@id='{$handle}']")) {
                return true;
            }
        }
        return false;
    }

isPageLayoutDesignAbstraction()

isPageLayoutDesignAbstraction

(

array

$abstraction

)

Check page_layout design abstractions that exist in the system

Parameters

array

$abstraction

Returns

bool

Implements ProcessorInterface.

Definition at line 897 of file Merge.php.

    {
        if (!isset($abstraction['design_abstraction'])) {
            return false;
        }
        return $abstraction['design_abstraction'] === self::DESIGN_ABSTRACTION_PAGE_LAYOUT;
    }

load()

load

(

$handles = []

)

Load layout updates by handles

Parameters

array | string

$handles

Exceptions

Implements ProcessorInterface.

Definition at line 428 of file Merge.php.

    {
        if (is_string($handles)) {
            $handles = [$handles];
        } elseif (!is_array($handles)) {
            throw new \Magento\Framework\Exception\LocalizedException(
                new \Magento\Framework\Phrase('Invalid layout update handle')
            );
        }

        $this->addHandle($handles);

        $cacheId = $this->getCacheId();
        $cacheIdPageLayout = $cacheId . '_' . self::PAGE_LAYOUT_CACHE_SUFFIX;
        $result = $this->_loadCache($cacheId);
        if ($result) {
            $this->addUpdate($result);
            $this->pageLayout = $this->_loadCache($cacheIdPageLayout);
            foreach ($this->getHandles() as $handle) {
                $this->allHandles[$handle] = $this->handleProcessed;
            }
            return $this;
        }

        foreach ($this->getHandles() as $handle) {
            $this->_merge($handle);
        }

        $layout = $this->asString();
        $this->_validateMergedLayout($cacheId, $layout);
        $this->_saveCache($layout, $cacheId, $this->getHandles());
        $this->_saveCache((string)$this->pageLayout, $cacheIdPageLayout, $this->getHandles());
        return $this;
    }

pageHandleExists()

pageHandleExists

(

$handleName

)

Whether a page handle is declared in the system or not

Parameters

string

$handleName

Returns

bool

Definition at line 312 of file Merge.php.

    {
        return (bool)$this->_getPageHandleNode($handleName);
    }

removeHandle()

removeHandle

(

$handleName

)

Remove handle from update

Parameters

string

$handleName

Returns

$this

Implements ProcessorInterface.

Definition at line 268 of file Merge.php.

    {
        unset($this->handles[$handleName]);
        return $this;
    }

validateUpdate()

validateUpdate	(		$handle,
			$updateXml
	)

Validate layout update content, throw exception on failure.

This method is used as a hook for plugins.

Parameters

string	$handle
string	$updateXml

Returns

void

Exceptions

Definition at line 603 of file Merge.php.

    {
        return;
    }

Field Documentation

$allHandles

$allHandles = []

protected

Definition at line 144 of file Merge.php.

$cache

$cache

protected

Definition at line 117 of file Merge.php.

$cacheSuffix

$cacheSuffix

protected

Definition at line 137 of file Merge.php.

$handleProcessed

$handleProcessed = 2

protected

Definition at line 158 of file Merge.php.

$handleProcessing

$handleProcessing = 1

protected

Definition at line 151 of file Merge.php.

$handles

$handles = []

protected

Definition at line 76 of file Merge.php.

$layoutUpdatesCache

$layoutUpdatesCache

protected

Definition at line 62 of file Merge.php.

$layoutValidator

$layoutValidator

protected

Definition at line 122 of file Merge.php.

$logger

$logger

protected

Definition at line 127 of file Merge.php.

$pageHandles

$pageHandles = []

protected

Definition at line 83 of file Merge.php.

$pageLayout

$pageLayout

protected

Definition at line 132 of file Merge.php.

$subst

$subst = null

protected

Definition at line 90 of file Merge.php.

$updates

$updates = []

protected

Definition at line 69 of file Merge.php.

DESIGN_ABSTRACTION_CUSTOM

const DESIGN_ABSTRACTION_CUSTOM = 'custom'

Layout abstraction based on designer prerogative.

Definition at line 25 of file Merge.php.

DESIGN_ABSTRACTION_PAGE_LAYOUT

const DESIGN_ABSTRACTION_PAGE_LAYOUT = 'page_layout'

Layout generalization guaranteed to load into View

Definition at line 30 of file Merge.php.

PAGE_LAYOUT_CACHE_SUFFIX

const PAGE_LAYOUT_CACHE_SUFFIX = 'page_layout'

Cache id suffix for page layout

Definition at line 45 of file Merge.php.

TYPE_ATTRIBUTE

const TYPE_ATTRIBUTE = 'xsi:type'

Name of an attribute that stands for data type of node values

Definition at line 40 of file Merge.php.

XPATH_HANDLE_DECLARATION

const XPATH_HANDLE_DECLARATION = '/layout[@design_abstraction]'

XPath of handles originally declared in layout updates

Definition at line 35 of file Merge.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/View/Model/Layout/Merge.php