Reader Class Reference

Public Member Functions
	__construct (\Magento\Framework\View\Design\Theme\ResolverInterface $themeResolver, \Magento\Framework\View\Layout\ProcessorFactory $processorFactory, \Magento\Framework\View\File\CollectorInterface $pageLayoutFileSource, \Magento\Framework\View\Layout\ReaderPool $reader)
	read (Layout\Reader\Context $readerContext, $pageLayout)

Data Fields
const	MERGE_CACHE_SUFFIX = 'page_layout'

Protected Member Functions
	getPageLayoutMerge ()

Protected Attributes
	$themeResolver
	$processorFactory
	$pageLayoutFileSource
	$pageLayoutMerge
	$reader

Detailed Description

Class Page layout reader

Definition at line 14 of file Reader.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\View\Design\Theme\ResolverInterface	$themeResolver,
		\Magento\Framework\View\Layout\ProcessorFactory	$processorFactory,
		\Magento\Framework\View\File\CollectorInterface	$pageLayoutFileSource,
		\Magento\Framework\View\Layout\ReaderPool	$reader
	)

Constructor

Parameters

\Magento\Framework\View\Design\Theme\ResolverInterface	$themeResolver
\Magento\Framework\View\Layout\ProcessorFactory	$processorFactory
\Magento\Framework\View\File\CollectorInterface	$pageLayoutFileSource
\Magento\Framework\View\Layout\ReaderPool	$reader

Definition at line 54 of file Reader.php.

      {
        $this->themeResolver = $themeResolver;
        $this->processorFactory = $processorFactory;
        $this->pageLayoutFileSource = $pageLayoutFileSource;
        $this->reader = $reader;
    }

Member Function Documentation

getPageLayoutMerge()

getPageLayoutMerge ( )

protected

Retrieve the layout update instance

Returns

\Magento\Framework\View\Layout\ProcessorInterface

Definition at line 71 of file Reader.php.

    {
        if ($this->pageLayoutMerge) {
            return $this->pageLayoutMerge;
        }
        $this->pageLayoutMerge = $this->processorFactory->create([
            'theme'       => $this->themeResolver->get(),
            'fileSource'  => $this->pageLayoutFileSource,
            'cacheSuffix' => self::MERGE_CACHE_SUFFIX,
        ]);
        return $this->pageLayoutMerge;
    }

read()

read	(	Layout\Reader\Context	$readerContext,
			$pageLayout
	)

Read page layout structure and fill reader context

Parameters

Layout\Reader\Context	$readerContext
string	$pageLayout

Returns

void

Definition at line 91 of file Reader.php.

    {
        $this->getPageLayoutMerge()->load($pageLayout);
        $xml = $this->getPageLayoutMerge()->asSimplexml();
        $this->reader->interpret($readerContext, $xml);
    }

Field Documentation

$pageLayoutFileSource

$pageLayoutFileSource

protected

Definition at line 34 of file Reader.php.

$pageLayoutMerge

$pageLayoutMerge

protected

Definition at line 39 of file Reader.php.

$processorFactory

$processorFactory

protected

Definition at line 29 of file Reader.php.

$reader

$reader

protected

Definition at line 44 of file Reader.php.

$themeResolver

$themeResolver

protected

Definition at line 24 of file Reader.php.

MERGE_CACHE_SUFFIX

const MERGE_CACHE_SUFFIX = 'page_layout'

Merge cache suffix

Definition at line 19 of file Reader.php.

---

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

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