View Class Reference

Inheritance diagram for View:

Public Member Functions
	__construct (\Magento\Framework\View\LayoutInterface $layout, RequestInterface $request, ResponseInterface $response, \Magento\Framework\Config\ScopeInterface $configScope, \Magento\Framework\Event\ManagerInterface $eventManager, \Magento\Framework\View\Result\PageFactory $pageFactory, ActionFlag $actionFlag)
	getPage ()
	getLayout ()
	loadLayout ($handles=null, $generateBlocks=true, $generateXml=true, $addActionHandles=true)
	getDefaultLayoutHandle ()
	addActionLayoutHandles ()
	addPageLayoutHandles (array $parameters=[], $defaultHandle=null)
	loadLayoutUpdates ()
	generateLayoutXml ()
	generateLayoutBlocks ()
	renderLayout ($output='')
	setIsLayoutLoaded ($value)
	isLayoutLoaded ()

Protected Attributes
	$_layout
	$_configScope
	$_eventManager
	$page
	$_actionFlag
	$_response
	$_request
	$_isLayoutLoaded = false

Detailed Description

Definition at line 8 of file View.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\View\LayoutInterface	$layout,
		RequestInterface	$request,
		ResponseInterface	$response,
		\Magento\Framework\Config\ScopeInterface	$configScope,
		\Magento\Framework\Event\ManagerInterface	$eventManager,
		\Magento\Framework\View\Result\PageFactory	$pageFactory,
		ActionFlag	$actionFlag
	)

Parameters

\Magento\Framework\View\LayoutInterface	$layout
RequestInterface	$request
ResponseInterface	$response
\Magento\Framework\Config\ScopeInterface	$configScope
\Magento\Framework\Event\ManagerInterface	$eventManager
\Magento\Framework\View\Result\PageFactory	$pageFactory
ActionFlag	$actionFlag

Definition at line 59 of file View.php.

      {
        $this->_layout = $layout;
        $this->_request = $request;
        $this->_response = $response;
        $this->_configScope = $configScope;
        $this->_eventManager = $eventManager;
        $this->_actionFlag = $actionFlag;
        $this->page = $pageFactory->create(true);
    }

Member Function Documentation

addActionLayoutHandles()

addActionLayoutHandles

(

)

Add layout handle by full controller action name

Returns

$this

Implements ViewInterface.

Definition at line 145 of file View.php.

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

addPageLayoutHandles()

addPageLayoutHandles	(	array	$parameters = [],
			$defaultHandle = null
	)

Add layout updates handles associated with the action page

Parameters

array | null	$parameters	page parameters
string | null	$defaultHandle

Returns

bool

Implements ViewInterface.

Definition at line 158 of file View.php.

    {
        return $this->page->addPageLayoutHandles($parameters, $defaultHandle);
    }

generateLayoutBlocks()

generateLayoutBlocks

(

)

Generate layout blocks

Returns

$this

Implements ViewInterface.

Definition at line 190 of file View.php.

    {
        $this->page->getConfig()->publicBuild();
        return $this;
    }

generateLayoutXml()

generateLayoutXml

(

)

Generate layout xml

Returns

$this

Implements ViewInterface.

Definition at line 179 of file View.php.

    {
        $this->page->getConfig()->publicBuild();
        return $this;
    }

getDefaultLayoutHandle()

getDefaultLayoutHandle

(

)

Retrieve the default layout handle name for the current action

Returns

string

Implements ViewInterface.

Definition at line 135 of file View.php.

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

getLayout()

getLayout

(

)

Retrieve current layout object

Returns

\Magento\Framework\View\LayoutInterface

Implements ViewInterface.

Definition at line 92 of file View.php.

    {
        return $this->page->getLayout();
    }

getPage()

getPage

(

)

Retrieve current page object

Returns

\Magento\Framework\View\Result\Page

Implements ViewInterface.

Definition at line 82 of file View.php.

    {
        return $this->page;
    }

isLayoutLoaded()

isLayoutLoaded

(

)

Returns is layout loaded

Returns

bool

Implements ViewInterface.

Definition at line 244 of file View.php.

    {
        return $this->_isLayoutLoaded;
    }

loadLayout()

loadLayout	(		$handles = null,
			$generateBlocks = true,
			$generateXml = true,
			$addActionHandles = true
	)

{Load layout by handles(s)

Parameters

string | null | bool	$handles
bool	$generateBlocks
bool	$generateXml
bool	$addActionHandles

Returns

ViewInterface

Exceptions

}

Implements ViewInterface.

Definition at line 100 of file View.php.

    {
        if ($this->_isLayoutLoaded) {
            throw new \RuntimeException('Layout must be loaded only once.');
        }
        // if handles were specified in arguments load them first
        if (!empty($handles)) {
            $this->getLayout()->getUpdate()->addHandle($handles);
        }

        if ($addActionHandles) {
            // add default layout handles for this action
            $this->page->initLayout();
        }
        $this->loadLayoutUpdates();

        if (!$generateXml) {
            return $this;
        }
        $this->generateLayoutXml();

        if (!$generateBlocks) {
            return $this;
        }
        $this->generateLayoutBlocks();
        $this->_isLayoutLoaded = true;

        return $this;
    }

loadLayoutUpdates()

loadLayoutUpdates

(

)

Load layout updates

Returns

$this

Implements ViewInterface.

Definition at line 168 of file View.php.

    {
        $this->page->getConfig()->publicBuild();
        return $this;
    }

renderLayout()

renderLayout

(

$output = ''

)

Rendering layout

Parameters

string

$output

Returns

$this

Implements ViewInterface.

Definition at line 202 of file View.php.

    {
        if ($this->_actionFlag->get('', 'no-renderLayout')) {
            return $this;
        }

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

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

        if ('' !== $output) {
            $this->getLayout()->addOutputElement($output);
        }

        $this->_eventManager->dispatch('controller_action_layout_render_before');
        $this->_eventManager->dispatch(
            'controller_action_layout_render_before_' . $this->_request->getFullActionName()
        );

        $this->page->renderResult($this->_response);
        \Magento\Framework\Profiler::stop('layout_render');

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

setIsLayoutLoaded()

setIsLayoutLoaded

(

$value

)

Set isLayoutLoaded flag

Parameters

bool

$value

Returns

void

Implements ViewInterface.

Definition at line 234 of file View.php.

    {
        $this->_isLayoutLoaded = $value;
    }

Field Documentation

$_actionFlag

$_actionFlag

protected

Definition at line 33 of file View.php.

$_configScope

$_configScope

protected

Definition at line 18 of file View.php.

$_eventManager

$_eventManager

protected

Definition at line 23 of file View.php.

$_isLayoutLoaded

$_isLayoutLoaded = false

protected

Definition at line 48 of file View.php.

$_layout

$_layout

protected

Definition at line 13 of file View.php.

$_request

$_request

protected

Definition at line 43 of file View.php.

$_response

$_response

protected

Definition at line 38 of file View.php.

$page

$page

protected

Definition at line 28 of file View.php.

---

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

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