1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\App;
/**
* Introduced as a facade for presentation related operations.
* Later replaced with Magento\Framework\View\Result component
*
* @api
* @deprecated 101.0.0
* @see \Magento\Framework\View\Result\Layout
* @since 100.0.2
*/
interface ViewInterface
{
/**
* Load layout updates
*
* @return ViewInterface
*/
public function loadLayoutUpdates();
/**
* Rendering layout
*
* @param string $output
* @return ViewInterface
*/
public function renderLayout($output = '');
/**
* Retrieve the default layout handle name for the current action
*
* @return string
*/
public function getDefaultLayoutHandle();
/**
* Load layout by handles(s)
*
* @param string|null|bool $handles
* @param bool $generateBlocks
* @param bool $generateXml
* @param bool $addActionHandles
* @return ViewInterface
* @throws \RuntimeException
*/
public function loadLayout($handles = null, $generateBlocks = true, $generateXml = true, $addActionHandles = true);
/**
* Generate layout xml
*
* @return ViewInterface
*/
public function generateLayoutXml();
/**
* Add layout updates handles associated with the action page
*
* @param array $parameters page parameters
* @param string $defaultHandle
* @return bool
*/
public function addPageLayoutHandles(array $parameters = [], $defaultHandle = null);
/**
* Generate layout blocks
*
* @return ViewInterface
*/
public function generateLayoutBlocks();
/**
* Retrieve current page object
*
* @return \Magento\Framework\View\Result\Page
*/
public function getPage();
/**
* Retrieve current layout object
*
* @return \Magento\Framework\View\LayoutInterface
*/
public function getLayout();
/**
* Add layout handle by full controller action name
*
* @return ViewInterface
*/
public function addActionLayoutHandles();
/**
* Set isLayoutLoaded flag
*
* @param bool $value
* @return void
*/
public function setIsLayoutLoaded($value);
/**
* Returns is layout loaded
*
* @return bool
*/
public function isLayoutLoaded();
}