Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions | Protected Attributes
Layout Class Reference
Inheritance diagram for Layout:
Layout Config LayoutInterface

Public Member Functions

 isCacheable ()
 
 setIsCacheable ($isCacheable)
 
- Public Member Functions inherited from Layout
 __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='')
 

Protected Attributes

 $isCacheable = true
 
- Protected Attributes inherited from Layout
 $_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]"
 

Additional Inherited Members

- Data Fields inherited from Layout
const LAYOUT_NODE = '<layout/>'
 
- Protected Member Functions inherited from Layout
 build ()
 
 addToOutputRootContainers ()
 
 displayElement ($name)
 
 _renderBlock ($name)
 
 _renderUiComponent ($name)
 
 _renderContainer ($name, $useCache=true)
 
 _prepareMessageGroup ($messageGroups)
 
 getXml ()
 
- Protected Member Functions inherited from Config
 getXml ()
 

Detailed Description

Definition at line 9 of file Layout.php.

Member Function Documentation

◆ isCacheable()

isCacheable ( )
Returns
bool

Implements LayoutInterface.

Definition at line 19 of file Layout.php.

20  {
21  return $this->isCacheable && parent::isCacheable();
22  }

◆ setIsCacheable()

setIsCacheable (   $isCacheable)
Parameters
bool$isCacheable
Returns
void

Definition at line 28 of file Layout.php.

Field Documentation

◆ $isCacheable

$isCacheable = true
protected

Definition at line 14 of file Layout.php.


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