ViewInterface Interface Reference

Inheritance diagram for ViewInterface:

Public Member Functions
	loadLayoutUpdates ()
	renderLayout ($output='')
	getDefaultLayoutHandle ()
	loadLayout ($handles=null, $generateBlocks=true, $generateXml=true, $addActionHandles=true)
	generateLayoutXml ()
	addPageLayoutHandles (array $parameters=[], $defaultHandle=null)
	generateLayoutBlocks ()
	getPage ()
	getLayout ()
	addActionLayoutHandles ()
	setIsLayoutLoaded ($value)
	isLayoutLoaded ()

Detailed Description

Introduced as a facade for presentation related operations. Later replaced with Magento\Framework\View\Result component

@api

Deprecated:

101.0.0

See also

\Magento\Framework\View\Result\Layout

Since

100.0.2

Definition at line 17 of file ViewInterface.php.

Member Function Documentation

addActionLayoutHandles()

addActionLayoutHandles

(

)

Add layout handle by full controller action name

Returns

ViewInterface

Implemented in View.

addPageLayoutHandles()

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

Add layout updates handles associated with the action page

Parameters

array	$parameters	page parameters
string	$defaultHandle

Returns

bool

Implemented in View.

generateLayoutBlocks()

generateLayoutBlocks

(

)

Generate layout blocks

Returns

ViewInterface

Implemented in View.

generateLayoutXml()

generateLayoutXml

(

)

Generate layout xml

Returns

ViewInterface

Implemented in View.

getDefaultLayoutHandle()

getDefaultLayoutHandle

(

)

Retrieve the default layout handle name for the current action

Returns

string

Implemented in View.

getLayout()

getLayout

(

)

Retrieve current layout object

Returns

\Magento\Framework\View\LayoutInterface

Implemented in View.

getPage()

getPage

(

)

Retrieve current page object

Returns

\Magento\Framework\View\Result\Page

Implemented in View.

isLayoutLoaded()

isLayoutLoaded

(

)

Returns is layout loaded

Returns

bool

Implemented in View.

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

Implemented in View.

loadLayoutUpdates()

loadLayoutUpdates

(

)

Load layout updates

Returns

ViewInterface

Implemented in View.

renderLayout()

renderLayout

(

$output = ''

)

Rendering layout

Parameters

string

$output

Returns

ViewInterface

Implemented in View.

setIsLayoutLoaded()

setIsLayoutLoaded

(

$value

)

Set isLayoutLoaded flag

Parameters

bool

$value

Returns

void

Implemented in View.

---

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

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