Layout Class Reference

Inheritance diagram for Layout:

Data Structures
class	ElementTest
class	MergeTest

Public Member Functions
	__construct (Layout\ProcessorFactory $processorFactory, ManagerInterface $eventManager, Layout\Data\Structure $structure, MessageManagerInterface $messageManager, Design\Theme\ResolverInterface $themeResolver, Layout\ReaderPool $readerPool, Layout\GeneratorPool $generatorPool, FrontendInterface $cache, Layout\Reader\ContextFactory $readerContextFactory, Layout\Generator\ContextFactory $generatorContextFactory, AppState $appState, Logger $logger, $cacheable=true, SerializerInterface $serializer=null)
	setGeneratorPool (Layout\GeneratorPool $generatorPool)
	setBuilder (Layout\BuilderInterface $builder)
	publicBuild ()
	__destruct ()
	getUpdate ()
	generateXml ()
	generateElements ()
	getChildBlock ($parentName, $alias)
	setChild ($parentName, $elementName, $alias)
	reorderChild ($parentName, $childName, $offsetOrSibling, $after=true)
	unsetChild ($parentName, $alias)
	getChildNames ($parentName)
	getChildBlocks ($parentName)
	getChildName ($parentName, $alias)
	renderElement ($name, $useCache=true)
	renderNonCachedElement ($name)
	addToParentGroup ($blockName, $parentGroupName)
	getGroupChildNames ($blockName, $groupName)
	hasElement ($name)
	getElementProperty ($name, $attribute)
	isBlock ($name)
	isUiComponent ($name)
	isContainer ($name)
	isManipulationAllowed ($name)
	setBlock ($name, $block)
	unsetElement ($name)
	createBlock ($type, $name='', array $arguments=[])
	addBlock ($block, $name='', $parent='', $alias='')
	renameElement ($oldName, $newName)
	getAllBlocks ()
	getBlock ($name)
	getUiComponent ($name)
	getParentName ($childName)
	getElementAlias ($name)
	addOutputElement ($name)
	removeOutputElement ($name)
	getOutput ()
	getMessagesBlock ()
	getBlockSingleton ($type)
	addAdjustableRenderer ($namespace, $staticType, $dynamicType, $type, $template, $data=[])
	getRendererOptions ($namespace, $staticType, $dynamicType)
	initMessages ($messageGroups=[])
	isCacheable ()
	isPrivate ()
	setIsPrivate ($isPrivate=true)
	getReaderContext ()
Public Member Functions inherited from Config
	__construct ($sourceData=null)
	setXml (Element $node)
	getNode ($path=null)
	getXpath ($xpath)
	getXmlString ()
	loadFile ($filePath)
	loadString ($string)
	loadDom (\DOMNode $dom)
	setNode ($path, $value, $overwrite=true)
	applyExtends ()
	processFileData ($text)
	extend (Config $config, $overwrite=true)
	__destruct ()
Public Member Functions inherited from LayoutInterface
	addContainer ($name, $label, array $options=[], $parent='', $alias='')

Data Fields
const	LAYOUT_NODE = '<layout/>'

Protected Member Functions
	build ()
	addToOutputRootContainers ()
	displayElement ($name)
	_renderBlock ($name)
	_renderUiComponent ($name)
	_renderContainer ($name, $useCache=true)
	_prepareMessageGroup ($messageGroups)
	getXml ()
Protected Member Functions inherited from Config
	getXml ()

Protected Attributes
	$_update
	$_blocks = []
	$_output = []
	$sharedBlocks = []
	$_renderingOutput
	$_renderElementCache = []
	$structure
	$_renderers = []
	$_eventManager
	$_processorFactory
	$messageManager
	$isPrivate = false
	$themeResolver
	$readerPool
	$cacheable
	$generatorPool
	$builder
	$cache
	$readerContextFactory
	$generatorContextFactory
	$readerContext
	$appState
	$logger
Protected Attributes inherited from Config
	$_xml = null
	$_elementClass = \Magento\Framework\Simplexml\Element::class
	$_xpathExtends = "//*[@extends]"

Detailed Description

Layout model

@SuppressWarnings(PHPMD.ExcessiveClassComplexity) @SuppressWarnings(PHPMD.CouplingBetweenObjects) @SuppressWarnings(PHPMD.TooManyFields) @SuppressWarnings(PHPMD.ExcessivePublicCount) @SuppressWarnings(PHPMD.TooManyMethods) @SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 28 of file Layout.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Layout\ProcessorFactory	$processorFactory,
		ManagerInterface	$eventManager,
		Layout\Data\Structure	$structure,
		MessageManagerInterface	$messageManager,
		Design\Theme\ResolverInterface	$themeResolver,
		Layout\ReaderPool	$readerPool,
		Layout\GeneratorPool	$generatorPool,
		FrontendInterface	$cache,
		Layout\Reader\ContextFactory	$readerContextFactory,
		Layout\Generator\ContextFactory	$generatorContextFactory,
		AppState	$appState,
		Logger	$logger,
			$cacheable = true,
		SerializerInterface	$serializer = null
	)

Parameters

Layout\ProcessorFactory	$processorFactory
ManagerInterface	$eventManager
Layout\Data\Structure	$structure
MessageManagerInterface	$messageManager
Design\Theme\ResolverInterface	$themeResolver
Layout\ReaderPool	$readerPool
Layout\GeneratorPool	$generatorPool
FrontendInterface	$cache
Layout\Reader\ContextFactory	$readerContextFactory
Layout\Generator\ContextFactory	$generatorContextFactory
\Magento\Framework\App\State	$appState
\Psr\Log\LoggerInterface	$logger
bool	$cacheable
SerializerInterface | null	$serializer

Definition at line 190 of file Layout.php.

      {
        $this->_elementClass = \Magento\Framework\View\Layout\Element::class;
        $this->_renderingOutput = new \Magento\Framework\DataObject();
        $this->serializer = $serializer ?: ObjectManager::getInstance()->get(SerializerInterface::class);

        $this->_processorFactory = $processorFactory;
        $this->_eventManager = $eventManager;
        $this->structure = $structure;
        $this->messageManager = $messageManager;
        $this->themeResolver = $themeResolver;
        $this->readerPool = $readerPool;
        $this->generatorPool = $generatorPool;
        $this->cacheable = $cacheable;
        $this->cache = $cache;
        $this->readerContextFactory = $readerContextFactory;
        $this->generatorContextFactory = $generatorContextFactory;
        $this->appState = $appState;
        $this->logger = $logger;
    }

__destruct()

__destruct

(

)

Cleanup circular references between layout & blocks

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

Definition at line 272 of file Layout.php.

    {
        if (isset($this->_update) && is_object($this->_update)) {
            $this->_update->__destruct();
            $this->_update = null;
        }
        $this->_blocks = [];
        parent::__destruct();
    }

Member Function Documentation

_prepareMessageGroup()

_prepareMessageGroup (   $messageGroups )

protected

Validate message groups

Parameters

array

$messageGroups

Returns

array

Definition at line 1079 of file Layout.php.

    {
        if (!is_array($messageGroups)) {
            $messageGroups = [$messageGroups];
        } elseif (empty($messageGroups)) {
            $messageGroups[] = $this->messageManager->getDefaultGroup();
        }
        return $messageGroups;
    }

_renderBlock()

_renderBlock (   $name )

protected

Gets HTML of block element

Parameters

string

$name

Returns

string

Exceptions

Definition at line 554 of file Layout.php.

    {
        $block = $this->getBlock($name);
        return $block ? $block->toHtml() : '';
    }

_renderContainer()

_renderContainer (   $name,   $useCache = true  )

protected

Gets HTML of container element

Parameters

string	$name
bool	$useCache

Returns

string

Definition at line 580 of file Layout.php.

    {
        $html = '';
        $children = $this->getChildNames($name);
        foreach ($children as $child) {
            $html .= $this->renderElement($child, $useCache);
        }
        if ($html == '' || !$this->structure->getAttribute($name, Element::CONTAINER_OPT_HTML_TAG)) {
            return $html;
        }

        $htmlId = $this->structure->getAttribute($name, Element::CONTAINER_OPT_HTML_ID);
        if ($htmlId) {
            $htmlId = ' id="' . $htmlId . '"';
        }

        $htmlClass = $this->structure->getAttribute($name, Element::CONTAINER_OPT_HTML_CLASS);
        if ($htmlClass) {
            $htmlClass = ' class="' . $htmlClass . '"';
        }

        $htmlTag = $this->structure->getAttribute($name, Element::CONTAINER_OPT_HTML_TAG);

        $html = sprintf('<%1$s%2$s%3$s>%4$s</%1$s>', $htmlTag, $htmlId, $htmlClass, $html);

        return $html;
    }

_renderUiComponent()

_renderUiComponent (   $name )

protected

Gets HTML of Ui Component

Parameters

string

$name

Returns

string

Exceptions

Definition at line 567 of file Layout.php.

    {
        $uiComponent = $this->getUiComponent($name);
        return $uiComponent ? $uiComponent->toHtml() : '';
    }

addAdjustableRenderer()

addAdjustableRenderer	(		$namespace,
			$staticType,
			$dynamicType,
			$type,
			$template,
			$data = []
	)

Parameters

string	$namespace
string	$staticType
string	$dynamicType
string	$type
string	$template
array	$data

Returns

$this

Definition at line 1003 of file Layout.php.

    {
        $this->_renderers[$namespace][$staticType][$dynamicType] = [
            'type' => $type,
            'template' => $template,
            'data' => $data,
        ];
        return $this;
    }

addBlock()

addBlock	(		$block,
			$name = '',
			$parent = '',
			$alias = ''
	)

Add a block to registry, create new object if needed

Parameters

string | \Magento\Framework\View\Element\AbstractBlock	$block
string	$name
string	$parent
string	$alias

Returns

\Magento\Framework\View\Element\AbstractBlock

Implements LayoutInterface.

Definition at line 790 of file Layout.php.

    {
        $this->build();
        if ($block instanceof \Magento\Framework\View\Element\AbstractBlock) {
            $name = $name ?: $block->getNameInLayout();
        } else {
            $block = $this->_createBlock($block, $name);
        }
        $name = $this->structure->createStructuralElement(
            $name,
            Element::TYPE_BLOCK,
            $name ?: get_class($block)
        );
        $this->setBlock($name, $block);
        $block->setNameInLayout($name);
        if ($parent) {
            $this->structure->setAsChild($name, $parent, $alias);
        }
        $block->setLayout($this);
        return $block;
    }

addOutputElement()

addOutputElement

(

$name

)

Add an element to output

Parameters

string

$name

Returns

$this

Implements LayoutInterface.

Definition at line 924 of file Layout.php.

    {
        $this->_output[$name] = $name;
        return $this;
    }

addToOutputRootContainers()

addToOutputRootContainers ( )

protected

Add parent containers to output

Returns

$this

Definition at line 355 of file Layout.php.

    {
        foreach ($this->structure->exportElements() as $name => $element) {
            if ($element['type'] === Element::TYPE_CONTAINER && empty($element['parent'])) {
                $this->addOutputElement($name);
            }
        }
        return $this;
    }

addToParentGroup()

addToParentGroup	(		$blockName,
			$parentGroupName
	)

Add element to parent group

Parameters

string	$blockName
string	$parentGroupName

Returns

bool

Implements LayoutInterface.

Definition at line 615 of file Layout.php.

    {
        $this->build();
        return $this->structure->addToParentGroup($blockName, $parentGroupName);
    }

build()

build ( )

protected

Build layout blocks from generic layouts and/or page configurations

Returns

void

Definition at line 250 of file Layout.php.

    {
        if (!empty($this->builder)) {
            $this->builder->build();
        }
    }

createBlock()

createBlock	(		$type,
			$name = '',
		array	$arguments = []
	)

Block Factory

Parameters

string	$type
string	$name
array	$arguments

Returns

\Magento\Framework\View\Element\AbstractBlock

Implements LayoutInterface.

Definition at line 755 of file Layout.php.

    {
        $this->build();
        $name = $this->structure->createStructuralElement($name, Element::TYPE_BLOCK, $type);
        $block = $this->_createBlock($type, $name, $arguments);
        $block->setLayout($this);
        return $block;
    }

displayElement()

displayElement (   $name )

protected

Define whether to display element Display if 'display' attribute is absent (false, null) or equal true ('1', true, 'true') In any other cases - do not display

Parameters

string

$name

Returns

bool

Definition at line 509 of file Layout.php.

    {
        $display = $this->structure->getAttribute($name, 'display');
        if ($display === '' || $display === false || $display === null
            || filter_var($display, FILTER_VALIDATE_BOOLEAN)) {
            return true;
        }
        return false;
    }

generateElements()

generateElements

(

)

Create structure of elements from the loaded XML configuration

Returns

void

Implements LayoutInterface.

Definition at line 314 of file Layout.php.

    {
        \Magento\Framework\Profiler::start(__CLASS__ . '::' . __METHOD__);
        $cacheId = 'structure_' . $this->getUpdate()->getCacheId();
        $result = $this->cache->load($cacheId);
        if ($result) {
            $data = $this->serializer->unserialize($result);
            $this->getReaderContext()->getPageConfigStructure()->populateWithArray($data['pageConfigStructure']);
            $this->getReaderContext()->getScheduledStructure()->populateWithArray($data['scheduledStructure']);
        } else {
            \Magento\Framework\Profiler::start('build_structure');
            $this->readerPool->interpret($this->getReaderContext(), $this->getNode());
            \Magento\Framework\Profiler::stop('build_structure');

            $data = [
                'pageConfigStructure' => $this->getReaderContext()->getPageConfigStructure()->__toArray(),
                'scheduledStructure'  => $this->getReaderContext()->getScheduledStructure()->__toArray(),
            ];
            $this->cache->save($this->serializer->serialize($data), $cacheId, $this->getUpdate()->getHandles());
        }

        $generatorContext = $this->generatorContextFactory->create(
            [
                'structure' => $this->structure,
                'layout' => $this,
            ]
        );

        \Magento\Framework\Profiler::start('generate_elements');
        $this->generatorPool->process($this->getReaderContext(), $generatorContext);
        \Magento\Framework\Profiler::stop('generate_elements');

        $this->addToOutputRootContainers();
        \Magento\Framework\Profiler::stop(__CLASS__ . '::' . __METHOD__);
    }

generateXml()

generateXml

(

)

Layout xml generation

Returns

$this

Implements LayoutInterface.

Definition at line 301 of file Layout.php.

    {
        $xml = $this->getUpdate()->asSimplexml();
        $this->setXml($xml);
        $this->structure->importElements([]);
        return $this;
    }

getAllBlocks()

getAllBlocks

(

)

Retrieve all blocks from registry as array

Returns

array

Implements LayoutInterface.

Definition at line 861 of file Layout.php.

    {
        $this->build();
        return $this->_blocks;
    }

getBlock()

getBlock

(

$name

)

Get block object by name

Parameters

string

$name

Returns

\Magento\Framework\View\Element\AbstractBlock|bool

Implements LayoutInterface.

Definition at line 873 of file Layout.php.

    {
        $this->build();
        if (isset($this->_blocks[$name])) {
            return $this->_blocks[$name];
        } else {
            return false;
        }
    }

getBlockSingleton()

getBlockSingleton

(

$type

)

Get block singleton

Parameters

string

$type

Returns

\Magento\Framework\App\Helper\AbstractHelper

Exceptions

Implements LayoutInterface.

Definition at line 981 of file Layout.php.

    {
        if (empty($type)) {
            throw new \Magento\Framework\Exception\LocalizedException(
                new \Magento\Framework\Phrase('Invalid block type')
            );
        }
        if (!isset($this->sharedBlocks[$type])) {
            $this->sharedBlocks[$type] = $this->createBlock($type);
        }
        return $this->sharedBlocks[$type];
    }

getChildBlock()

getChildBlock	(		$parentName,
			$alias
	)

Get child block if exists

Parameters

string	$parentName
string	$alias

Returns

bool|\Magento\Framework\View\Element\AbstractBlock

Implements LayoutInterface.

Definition at line 372 of file Layout.php.

    {
        $this->build();
        $name = $this->structure->getChildId($parentName, $alias);
        if ($this->isBlock($name)) {
            return $this->getBlock($name);
        }
        return false;
    }

getChildBlocks()

getChildBlocks

(

$parentName

)

Get list of child blocks

Returns associative array of <alias> => <block instance>="">

Parameters

string

$parentName

Returns

array

Implements LayoutInterface.

Definition at line 450 of file Layout.php.

    {
        $this->build();
        $blocks = [];
        foreach ($this->structure->getChildren($parentName) as $childName => $alias) {
            $block = $this->getBlock($childName);
            if ($block) {
                $blocks[$alias] = $block;
            }
        }
        return $blocks;
    }

getChildName()

getChildName	(		$parentName,
			$alias
	)

Get child name by alias

Parameters

string	$parentName
string	$alias

Returns

bool|string

Implements LayoutInterface.

Definition at line 470 of file Layout.php.

    {
        $this->build();
        return $this->structure->getChildId($parentName, $alias);
    }

getChildNames()

getChildNames

(

$parentName

)

Get list of child names

Parameters

string

$parentName

Returns

array

Implements LayoutInterface.

Definition at line 436 of file Layout.php.

    {
        $this->build();
        return array_keys($this->structure->getChildren($parentName));
    }

getElementAlias()

getElementAlias

(

$name

)

Get element alias by name

Parameters

string

$name

Returns

bool|string

Implements LayoutInterface.

Definition at line 912 of file Layout.php.

    {
        $this->build();
        return $this->structure->getChildAlias($this->structure->getParentId($name), $name);
    }

getElementProperty()

getElementProperty	(		$name,
			$attribute
	)

Get property value of an element

Parameters

string	$name
string	$attribute

Returns

mixed

Implements LayoutInterface.

Definition at line 653 of file Layout.php.

    {
        $this->build();
        return $this->structure->getAttribute($name, $attribute);
    }

getGroupChildNames()

getGroupChildNames	(		$blockName,
			$groupName
	)

Get element names for specified group

Parameters

string	$blockName
string	$groupName

Returns

array

Implements LayoutInterface.

Definition at line 628 of file Layout.php.

    {
        $this->build();
        return $this->structure->getGroupChildNames($blockName, $groupName);
    }

getMessagesBlock()

getMessagesBlock

(

)

Retrieve messages block

Returns

\Magento\Framework\View\Element\Messages

Implements LayoutInterface.

Definition at line 964 of file Layout.php.

    {
        $this->build();
        $block = $this->getBlock('messages');
        if ($block) {
            return $block;
        }
        return $this->createBlock(\Magento\Framework\View\Element\Messages::class, 'messages');
    }

getOutput()

getOutput

(

)

Get all blocks marked for output

Returns

string

Implements LayoutInterface.

Definition at line 949 of file Layout.php.

    {
        $this->build();
        $out = '';
        foreach ($this->_output as $name) {
            $out .= $this->renderElement($name);
        }
        return $out;
    }

getParentName()

getParentName

(

$childName

)

Gets parent name of an element with specified name

Parameters

string

$childName

Returns

bool|string

Implements LayoutInterface.

Definition at line 900 of file Layout.php.

    {
        $this->build();
        return $this->structure->getParentId($childName);
    }

getReaderContext()

getReaderContext

(

)

Getter and lazy loader for reader context

Returns

Layout\Reader\Context

Definition at line 1141 of file Layout.php.

    {
        if (!$this->readerContext) {
            $this->readerContext = $this->readerContextFactory->create();
        }
        return $this->readerContext;
    }

getRendererOptions()

getRendererOptions	(		$namespace,
			$staticType,
			$dynamicType
	)

Parameters

string	$namespace
string	$staticType
string	$dynamicType

Returns

array|null

Definition at line 1019 of file Layout.php.

    {
        if (!isset($this->_renderers[$namespace])) {
            return null;
        }
        if (!isset($this->_renderers[$namespace][$staticType])) {
            return null;
        }
        if (!isset($this->_renderers[$namespace][$staticType][$dynamicType])) {
            return null;
        }
        return $this->_renderers[$namespace][$staticType][$dynamicType];
    }

getUiComponent()

getUiComponent

(

$name

)

Get Ui Component object by name

Parameters

string

$name

Returns

\Magento\Framework\View\Element\AbstractBlock|bool

Definition at line 889 of file Layout.php.

    {
        return $this->getBlock($name);
    }

getUpdate()

getUpdate

(

)

Retrieve the layout update instance

Returns

\Magento\Framework\View\Layout\ProcessorInterface

Implements LayoutInterface.

Definition at line 287 of file Layout.php.

    {
        if (!$this->_update) {
            $theme = $this->themeResolver->get();
            $this->_update = $this->_processorFactory->create(['theme' => $theme]);
        }
        return $this->_update;
    }

getXml()

getXml ( )

protected

Getter and lazy loader for xml element

Returns

\Magento\Framework\Simplexml\Element

Definition at line 1128 of file Layout.php.

    {
        if (!$this->_xml) {
            $this->setXml(simplexml_load_string(self::LAYOUT_NODE, $this->_elementClass));
        }
        return $this->_xml;
    }

hasElement()

hasElement

(

$name

)

Check if element exists in layout structure

Parameters

string

$name

Returns

bool

Implements LayoutInterface.

Definition at line 640 of file Layout.php.

    {
        $this->build();
        return $this->structure->hasElement($name);
    }

initMessages()

initMessages

(

$messageGroups = []

)

Init messages by message storage(s), loading and adding messages to layout messages block

Parameters

string | array

$messageGroups

Returns

void

Exceptions

Definition at line 1063 of file Layout.php.

    {
        $this->build();
        foreach ($this->_prepareMessageGroup($messageGroups) as $group) {
            $block = $this->getMessagesBlock();
            $block->addMessages($this->messageManager->getMessages(true, $group));
            $block->addStorageType($group);
        }
    }

isBlock()

isBlock

(

$name

)

Whether specified element is a block

Parameters

string

$name

Returns

bool

Implements LayoutInterface.

Definition at line 665 of file Layout.php.

    {
        $this->build();
        if ($this->structure->hasElement($name)) {
            return Element::TYPE_BLOCK === $this->structure->getAttribute($name, 'type');
        }
        return false;
    }

isCacheable()

isCacheable

(

)

Check is exists non-cacheable layout elements

Returns

bool

Implements LayoutInterface.

Definition at line 1094 of file Layout.php.

    {
        $this->build();
        $cacheableXml = !(bool)count($this->getXml()->xpath('//' . Element::TYPE_BLOCK . '[@cacheable="false"]'));
        return $this->cacheable && $cacheableXml;
    }

isContainer()

isContainer

(

$name

)

Checks if element with specified name is container

Parameters

string

$name

Returns

bool

Implements LayoutInterface.

Definition at line 695 of file Layout.php.

    {
        $this->build();
        if ($this->structure->hasElement($name)) {
            return Element::TYPE_CONTAINER === $this->structure->getAttribute($name, 'type');
        }
        return false;
    }

isManipulationAllowed()

isManipulationAllowed

(

$name

)

Whether the specified element may be manipulated externally

Parameters

string

$name

Returns

bool

Implements LayoutInterface.

Definition at line 710 of file Layout.php.

    {
        $this->build();
        $parentName = $this->structure->getParentId($name);
        return $parentName && $this->isContainer($parentName);
    }

isPrivate()

isPrivate

(

)

Check is exists non-cacheable layout elements

Returns

bool

Definition at line 1106 of file Layout.php.

    {
        return $this->isPrivate;
    }

isUiComponent()

isUiComponent

(

$name

)

Whether specified element is a UI Component

Parameters

string

$name

Returns

bool

Definition at line 680 of file Layout.php.

    {
        $this->build();
        if ($this->structure->hasElement($name)) {
            return Element::TYPE_UI_COMPONENT === $this->structure->getAttribute($name, 'type');
        }
        return false;
    }

publicBuild()

publicBuild

(

)

TODO Will be eliminated in MAGETWO-28359

Returns

void

Definition at line 261 of file Layout.php.

    {
        $this->build();
    }

removeOutputElement()

removeOutputElement

(

$name

)

Remove an element from output

Parameters

string

$name

Returns

$this

Implements LayoutInterface.

Definition at line 936 of file Layout.php.

    {
        if (isset($this->_output[$name])) {
            unset($this->_output[$name]);
        }
        return $this;
    }

renameElement()

renameElement	(		$oldName,
			$newName
	)

Rename element in layout and layout structure

Parameters

string	$oldName
string	$newName

Returns

bool

Implements LayoutInterface.

Definition at line 842 of file Layout.php.

    {
        $this->build();
        if (isset($this->_blocks[$oldName])) {
            $block = $this->_blocks[$oldName];
            $this->_blocks[$oldName] = null;
            unset($this->_blocks[$oldName]);
            $this->_blocks[$newName] = $block;
        }
        $this->structure->renameElement($oldName, $newName);

        return $this;
    }

renderElement()

renderElement	(		$name,
			$useCache = true
	)

Find an element in layout, render it and return string with its output

Parameters

string	$name
bool	$useCache

Returns

string

Implements LayoutInterface.

Definition at line 483 of file Layout.php.

    {
        $this->build();
        if (!isset($this->_renderElementCache[$name]) || !$useCache) {
            if ($this->displayElement($name)) {
                $this->_renderElementCache[$name] = $this->renderNonCachedElement($name);
            } else {
                return $this->_renderElementCache[$name] = '';
            }
        }
        $this->_renderingOutput->setData('output', $this->_renderElementCache[$name]);
        $this->_eventManager->dispatch(
            'core_layout_render_element',
            ['element_name' => $name, 'layout' => $this, 'transport' => $this->_renderingOutput]
        );
        return $this->_renderingOutput->getData('output');
    }

renderNonCachedElement()

renderNonCachedElement

(

$name

)

Render non cached element

Parameters

string

$name

Returns

string

Exceptions

Definition at line 526 of file Layout.php.

    {
        $result = '';
        try {
            if ($this->isUiComponent($name)) {
                $result = $this->_renderUiComponent($name);
            } elseif ($this->isBlock($name)) {
                $result = $this->_renderBlock($name);
            } else {
                $result = $this->_renderContainer($name, false);
            }
        } catch (\Exception $e) {
            if ($this->appState->getMode() === AppState::MODE_DEVELOPER) {
                throw $e;
            }
            $message = ($e instanceof LocalizedException) ? $e->getLogMessage() : $e->getMessage();
            $this->logger->critical($message);
        }
        return $result;
    }

reorderChild()

reorderChild	(		$parentName,
			$childName,
			$offsetOrSibling,
			$after = true
	)

Reorder a child of a specified element

If $offsetOrSibling is null, it will put the element to the end If $offsetOrSibling is numeric (integer) value, it will put the element after/before specified position Otherwise – after/before specified sibling

Parameters

string	$parentName
string	$childName
string | int | null	$offsetOrSibling
bool	$after

Returns

void

Implements LayoutInterface.

Definition at line 410 of file Layout.php.

    {
        $this->build();
        $this->structure->reorderChildElement($parentName, $childName, $offsetOrSibling, $after);
    }

setBlock()

setBlock	(		$name,
			$block
	)

Save block in blocks registry

Parameters

string	$name
\Magento\Framework\View\Element\AbstractBlock	$block

Returns

$this

Implements LayoutInterface.

Definition at line 724 of file Layout.php.

    {
        $this->_blocks[$name] = $block;
        return $this;
    }

setBuilder()

setBuilder

(

Layout\BuilderInterface

$builder

)

Parameters

Layout\BuilderInterface

$builder

Returns

$this

Definition at line 239 of file Layout.php.

    {
        $this->builder = $builder;
        return $this;
    }

setChild()

setChild	(		$parentName,
			$elementName,
			$alias
	)

Set child element into layout structure

Parameters

string	$parentName
string	$elementName
string	$alias

Returns

$this

Implements LayoutInterface.

Definition at line 390 of file Layout.php.

    {
        $this->build();
        $this->structure->setAsChild($elementName, $parentName, $alias);
        return $this;
    }

setGeneratorPool()

setGeneratorPool

(

Layout\GeneratorPool

$generatorPool

)

Parameters

Layout\GeneratorPool

$generatorPool

Returns

$this

Definition at line 229 of file Layout.php.

    {
        $this->generatorPool = $generatorPool;
        return $this;
    }

setIsPrivate()

setIsPrivate

(

$isPrivate = true

)

Mark layout as private

Parameters

bool

$isPrivate

Returns

Layout

Definition at line 1117 of file Layout.php.

    {
        $this->isPrivate = (bool)$isPrivate;
        return $this;
    }

unsetChild()

unsetChild	(		$parentName,
			$alias
	)

Remove child element from parent

Parameters

string	$parentName
string	$alias

Returns

$this

Implements LayoutInterface.

Definition at line 423 of file Layout.php.

    {
        $this->build();
        $this->structure->unsetChild($parentName, $alias);
        return $this;
    }

unsetElement()

unsetElement

(

$name

)

Remove block from registry

Parameters

string

$name

Returns

$this

Implements LayoutInterface.

Definition at line 736 of file Layout.php.

    {
        $this->build();
        if (isset($this->_blocks[$name])) {
            $this->_blocks[$name] = null;
            unset($this->_blocks[$name]);
        }
        $this->structure->unsetElement($name);
        return $this;
    }

Field Documentation

$_blocks

$_blocks = []

protected

Definition at line 48 of file Layout.php.

$_eventManager

$_eventManager

protected

Definition at line 97 of file Layout.php.

$_output

$_output = []

protected

Definition at line 55 of file Layout.php.

$_processorFactory

$_processorFactory

protected

Definition at line 102 of file Layout.php.

$_renderElementCache

$_renderElementCache = []

protected

Definition at line 76 of file Layout.php.

$_renderers

$_renderers = []

protected

Definition at line 90 of file Layout.php.

$_renderingOutput

$_renderingOutput

protected

Definition at line 69 of file Layout.php.

$_update

$_update

protected

Definition at line 41 of file Layout.php.

$appState

$appState

protected

Definition at line 162 of file Layout.php.

$builder

$builder

protected

Definition at line 137 of file Layout.php.

$cache

$cache

protected

Definition at line 142 of file Layout.php.

$cacheable

$cacheable

protected

Definition at line 127 of file Layout.php.

$generatorContextFactory

$generatorContextFactory

protected

Definition at line 152 of file Layout.php.

$generatorPool

$generatorPool

protected

Definition at line 132 of file Layout.php.

$isPrivate

$isPrivate = false

protected

Definition at line 112 of file Layout.php.

$logger

$logger

protected

Definition at line 167 of file Layout.php.

$messageManager

$messageManager

protected

Definition at line 107 of file Layout.php.

$readerContext

$readerContext

protected

Definition at line 157 of file Layout.php.

$readerContextFactory

$readerContextFactory

protected

Definition at line 147 of file Layout.php.

$readerPool

$readerPool

protected

Definition at line 122 of file Layout.php.

$sharedBlocks

$sharedBlocks = []

protected

Definition at line 62 of file Layout.php.

$structure

$structure

protected

Definition at line 83 of file Layout.php.

$themeResolver

$themeResolver

protected

Definition at line 117 of file Layout.php.

LAYOUT_NODE

const LAYOUT_NODE = '<layout/>'

Empty layout xml

Definition at line 34 of file Layout.php.

---

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

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