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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\View\Layout;
use Magento\Framework\App;
use Magento\Framework\Event;
use Magento\Framework\Profiler;
use Magento\Framework\View;
/**
* Class Builder
*/
class Builder implements BuilderInterface
{
/**
* @var \Magento\Framework\Event\ManagerInterface
*/
protected $eventManager;
/**
* @var \Magento\Framework\App\Request\Http
*/
protected $request;
/**
* @var \Magento\Framework\View\LayoutInterface
*/
protected $layout;
/**
* @var bool
*/
protected $isBuilt = false;
/**
* @param View\LayoutInterface $layout
* @param App\Request\Http $request
* @param Event\ManagerInterface $eventManager
*/
public function __construct(
View\LayoutInterface $layout,
App\Request\Http $request,
Event\ManagerInterface $eventManager
) {
$this->layout = $layout;
$this->request = $request;
$this->eventManager = $eventManager;
$this->layout->setBuilder($this);
}
/**
* Build layout structure
*
* @return \Magento\Framework\View\LayoutInterface
*/
public function build()
{
if (!$this->isBuilt) {
$this->isBuilt = true;
$this->loadLayoutUpdates();
$this->generateLayoutXml();
$this->generateLayoutBlocks();
}
return $this->layout;
}
/**
* Load layout updates
*
* @return $this
*/
protected function loadLayoutUpdates()
{
Profiler::start('LAYOUT');
/* dispatch event for adding handles to layout update */
$this->eventManager->dispatch(
'layout_load_before',
['full_action_name' => $this->request->getFullActionName(), 'layout' => $this->layout]
);
Profiler::start('layout_load');
/* load layout updates by specified handles */
$this->layout->getUpdate()->load();
Profiler::stop('layout_load');
Profiler::stop('LAYOUT');
return $this;
}
/**
* Generate layout xml
*
* @return $this
*/
protected function generateLayoutXml()
{
Profiler::start('LAYOUT');
Profiler::start('layout_generate_xml');
/* generate xml from collected text updates */
$this->layout->generateXml();
Profiler::stop('layout_generate_xml');
Profiler::stop('LAYOUT');
return $this;
}
/**
* Generate layout blocks
*
* @return $this
*/
protected function generateLayoutBlocks()
{
$this->beforeGenerateBlock();
Profiler::start('LAYOUT');
/* dispatch event for adding xml layout elements */
$this->eventManager->dispatch(
'layout_generate_blocks_before',
['full_action_name' => $this->request->getFullActionName(), 'layout' => $this->layout]
);
Profiler::start('layout_generate_blocks');
/* generate blocks from xml layout */
$this->layout->generateElements();
Profiler::stop('layout_generate_blocks');
$this->eventManager->dispatch(
'layout_generate_blocks_after',
['full_action_name' => $this->request->getFullActionName(), 'layout' => $this->layout]
);
Profiler::stop('LAYOUT');
$this->afterGenerateBlock();
return $this;
}
/**
* @return $this
*/
protected function beforeGenerateBlock()
{
return $this;
}
/**
* @return $this
*/
protected function afterGenerateBlock()
{
return $this;
}
}