Layout Class Reference

Inheritance diagram for Layout:

Public Member Functions
	__construct (View\Element\Template\Context $context, View\LayoutFactory $layoutFactory, View\Layout\ReaderPool $layoutReaderPool, Framework\Translate\InlineInterface $translateInline, View\Layout\BuilderFactory $layoutBuilderFactory, View\Layout\GeneratorPool $generatorPool, $isIsolated=false)
	getLayout ()
	addDefaultHandle ()
	getDefaultLayoutHandle ()
	addHandle ($handleName)
	addUpdate ($update)
	renderResult (ResponseInterface $httpResponse)
Public Member Functions inherited from AbstractResult
	setHttpResponseCode ($httpCode)
	setHeader ($name, $value, $replace=false)
	setStatusHeader ($httpCode, $version=null, $phrase=null)
	renderResult (ResponseInterface $response)

Protected Member Functions
	initLayoutBuilder ()
	render (HttpResponseInterface $response)
Protected Member Functions inherited from AbstractResult
	applyHttpHeaders (HttpResponseInterface $response)
	render (HttpResponseInterface $response)

Protected Attributes
	$layoutFactory
	$layoutBuilderFactory
	$layoutReaderPool
	$layout
	$translateInline
	$eventManager
	$request
Protected Attributes inherited from AbstractResult
	$httpResponseCode
	$headers = []
	$statusHeaderCode
	$statusHeaderVersion
	$statusHeaderPhrase

Detailed Description

A generic layout response can be used for rendering any kind of layout So it comprises a response body from the layout elements it has and sets it to the HTTP response

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

@api

Since

100.0.2

Definition at line 24 of file Layout.php.

Constructor & Destructor Documentation

__construct()

__construct	(	View\Element\Template\Context	$context,
		View\LayoutFactory	$layoutFactory,
		View\Layout\ReaderPool	$layoutReaderPool,
		Framework\Translate\InlineInterface	$translateInline,
		View\Layout\BuilderFactory	$layoutBuilderFactory,
		View\Layout\GeneratorPool	$generatorPool,
			$isIsolated = false
	)

Constructor

Parameters

View\Element\Template\Context	$context
View\LayoutFactory	$layoutFactory
View\Layout\ReaderPool	$layoutReaderPool
Framework\Translate\InlineInterface	$translateInline
View\Layout\BuilderFactory	$layoutBuilderFactory
View\Layout\GeneratorPool	$generatorPool
bool	$isIsolated

Definition at line 72 of file Layout.php.

      {
        $this->layoutFactory = $layoutFactory;
        $this->layoutBuilderFactory = $layoutBuilderFactory;
        $this->layoutReaderPool = $layoutReaderPool;
        $this->eventManager = $context->getEventManager();
        $this->request = $context->getRequest();
        $this->translateInline = $translateInline;
        // TODO Shared layout object will be deleted in MAGETWO-28359
        $this->layout = $isIsolated
            ? $this->layoutFactory->create(['reader' => $this->layoutReaderPool, 'generatorPool' => $generatorPool])
            : $context->getLayout();
        $this->layout->setGeneratorPool($generatorPool);
        $this->initLayoutBuilder();
    }

Member Function Documentation

addDefaultHandle()

addDefaultHandle

(

)

Returns

$this

Definition at line 118 of file Layout.php.

    {
        $this->addHandle($this->getDefaultLayoutHandle());
        return $this;
    }

addHandle()

addHandle

(

$handleName

)

Parameters

string|string[]

$handleName

Returns

$this

Definition at line 138 of file Layout.php.

    {
        $this->getLayout()->getUpdate()->addHandle($handleName);
        return $this;
    }

addUpdate()

addUpdate

(

$update

)

Add update to merge object

Parameters

string

$update

Returns

$this

Definition at line 150 of file Layout.php.

    {
        $this->getLayout()->getUpdate()->addUpdate($update);
        return $this;
    }

getDefaultLayoutHandle()

getDefaultLayoutHandle

(

)

Retrieve the default layout handle name for the current action

Returns

string

Definition at line 129 of file Layout.php.

    {
        return strtolower($this->request->getFullActionName());
    }

getLayout()

getLayout

(

)

Get layout instance for current page

Returns

\Magento\Framework\View\LayoutInterface

Definition at line 110 of file Layout.php.

    {
        return $this->layout;
    }

initLayoutBuilder()

initLayoutBuilder ( )

protected

Create layout builder

Returns

void

Definition at line 100 of file Layout.php.

    {
        $this->layoutBuilderFactory->create(View\Layout\BuilderFactory::TYPE_LAYOUT, ['layout' => $this->layout]);
    }

render()

render ( HttpResponseInterface  $response )

protected

{}

Definition at line 181 of file Layout.php.

    {
        $output = $this->layout->getOutput();
        $this->translateInline->processResponseBody($output);
        $response->appendBody($output);
        return $this;
    }

renderResult()

renderResult

(

ResponseInterface

$httpResponse

)

Render current layout

Parameters

HttpResponseInterface | ResponseInterface

$httpResponse

Returns

$this

Implements ResultInterface.

Definition at line 162 of file Layout.php.

    {
        \Magento\Framework\Profiler::start('LAYOUT');
        \Magento\Framework\Profiler::start('layout_render');

        $this->eventManager->dispatch('layout_render_before');
        $this->eventManager->dispatch('layout_render_before_' . $this->request->getFullActionName());

        $this->applyHttpHeaders($httpResponse);
        $this->render($httpResponse);

        \Magento\Framework\Profiler::stop('layout_render');
        \Magento\Framework\Profiler::stop('LAYOUT');
        return $this;
    }

Field Documentation

$eventManager

$eventManager

protected

Definition at line 54 of file Layout.php.

$layout

$layout

protected

Definition at line 44 of file Layout.php.

$layoutBuilderFactory

$layoutBuilderFactory

protected

Definition at line 34 of file Layout.php.

$layoutFactory

$layoutFactory

protected

Definition at line 29 of file Layout.php.

$layoutReaderPool

$layoutReaderPool

protected

Definition at line 39 of file Layout.php.

$request

$request

protected

Definition at line 59 of file Layout.php.

$translateInline

$translateInline

protected

Definition at line 49 of file Layout.php.

---

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

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