Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
LayoutInterface.php
Go to the documentation of this file.
1 <?php
6 namespace Magento\Framework\View;
7 
13 interface LayoutInterface
14 {
20  public function getUpdate();
21 
27  public function generateXml();
28 
34  public function generateElements();
35 
43  public function renderElement($name, $useCache = true);
44 
51  public function addOutputElement($name);
52 
58  public function getOutput();
59 
66  public function hasElement($name);
67 
74  public function unsetElement($name);
75 
81  public function getAllBlocks();
82 
89  public function getBlock($name);
90 
98  public function getChildBlock($parentName, $alias);
99 
108  public function setChild($parentName, $elementName, $alias);
109 
123  public function reorderChild($parentName, $childName, $offsetOrSibling, $after = true);
124 
132  public function unsetChild($parentName, $alias);
133 
140  public function getChildNames($parentName);
141 
150  public function getChildBlocks($parentName);
151 
159  public function getChildName($parentName, $alias);
160 
168  public function addToParentGroup($blockName, $parentGroupName);
169 
177  public function getGroupChildNames($blockName, $groupName);
178 
185  public function getParentName($childName);
186 
195  public function createBlock($type, $name = '', array $arguments = []);
196 
206  public function addBlock($block, $name = '', $parent = '', $alias = '');
207 
218  public function addContainer($name, $label, array $options = [], $parent = '', $alias = '');
219 
227  public function renameElement($oldName, $newName);
228 
235  public function getElementAlias($name);
236 
243  public function removeOutputElement($name);
244 
250  public function getMessagesBlock();
251 
258  public function getBlockSingleton($type);
259 
267  public function getElementProperty($name, $attribute);
268 
275  public function isBlock($name);
276 
283  public function isContainer($name);
284 
291  public function isManipulationAllowed($name);
292 
300  public function setBlock($name, $block);
301 
307  public function isCacheable();
308 }
setChild($parentName, $elementName, $alias)
addToParentGroup($blockName, $parentGroupName)
getGroupChildNames($blockName, $groupName)
addContainer($name, $label, array $options=[], $parent='', $alias='')
$block
Definition: block.php:8
createBlock($type, $name='', array $arguments=[])
$type
Definition: item.phtml:13
addBlock($block, $name='', $parent='', $alias='')
$label
Definition: details.phtml:21
reorderChild($parentName, $childName, $offsetOrSibling, $after=true)
$arguments
if(!trim($html)) $alias
Definition: details.phtml:20
renderElement($name, $useCache=true)
$elementName
Definition: gallery.phtml:10
if(!isset($_GET['name'])) $name
Definition: log.php:14