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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\View\Layout\Reader;
use Magento\Framework\View\Layout;
/**
* Class Container
*/
class Container implements Layout\ReaderInterface
{
/**#@+
* Supported types
*/
const TYPE_CONTAINER = 'container';
const TYPE_REFERENCE_CONTAINER = 'referenceContainer';
/**#@-*/
/**#@+
* Names of container options in layout
*/
const CONTAINER_OPT_HTML_TAG = 'htmlTag';
const CONTAINER_OPT_HTML_CLASS = 'htmlClass';
const CONTAINER_OPT_HTML_ID = 'htmlId';
const CONTAINER_OPT_LABEL = 'label';
const CONTAINER_OPT_DISPLAY = 'display';
/**#@-*/
/**#@-*/
protected $helper;
/**
* @var \Magento\Framework\View\Layout\ReaderPool
*/
protected $readerPool;
/**
* Constructor
*
* @param Layout\ScheduledStructure\Helper $helper
* @param Layout\ReaderPool $readerPool
*/
public function __construct(
Layout\ScheduledStructure\Helper $helper,
Layout\ReaderPool $readerPool
) {
$this->helper = $helper;
$this->readerPool = $readerPool;
}
/**
* @return string[]
*/
public function getSupportedNodes()
{
return [self::TYPE_CONTAINER, self::TYPE_REFERENCE_CONTAINER];
}
/**
* {@inheritdoc}
*
* @param Context $readerContext
* @param Layout\Element $currentElement
* @param Layout\Element $parentElement
* @return $this
*/
public function interpret(Context $readerContext, Layout\Element $currentElement)
{
switch ($currentElement->getName()) {
case self::TYPE_CONTAINER:
$this->helper->scheduleStructure(
$readerContext->getScheduledStructure(),
$currentElement,
$currentElement->getParent()
);
$this->mergeContainerAttributes($readerContext->getScheduledStructure(), $currentElement);
break;
case self::TYPE_REFERENCE_CONTAINER:
$this->containerReference($readerContext->getScheduledStructure(), $currentElement);
break;
default:
break;
}
$this->readerPool->interpret($readerContext, $currentElement);
return $this;
}
/**
* Merge Container attributes
*
* @param \Magento\Framework\View\Layout\ScheduledStructure $scheduledStructure
* @param \Magento\Framework\View\Layout\Element $currentElement
* @return void
*/
protected function mergeContainerAttributes(
Layout\ScheduledStructure $scheduledStructure,
Layout\Element $currentElement
) {
$containerName = $currentElement->getAttribute('name');
$elementData = $scheduledStructure->getStructureElementData($containerName);
if (isset($elementData['attributes'])) {
$keys = array_keys($elementData['attributes']);
foreach ($keys as $key) {
if (isset($currentElement[$key])) {
$elementData['attributes'][$key] = (string)$currentElement[$key];
}
}
} else {
$elementData['attributes'] = [
self::CONTAINER_OPT_HTML_TAG => (string)$currentElement[self::CONTAINER_OPT_HTML_TAG],
self::CONTAINER_OPT_HTML_ID => (string)$currentElement[self::CONTAINER_OPT_HTML_ID],
self::CONTAINER_OPT_HTML_CLASS => (string)$currentElement[self::CONTAINER_OPT_HTML_CLASS],
self::CONTAINER_OPT_LABEL => (string)$currentElement[self::CONTAINER_OPT_LABEL],
self::CONTAINER_OPT_DISPLAY => (string)$currentElement[self::CONTAINER_OPT_DISPLAY],
];
}
$scheduledStructure->setStructureElementData($containerName, $elementData);
}
/**
* Handling reference of container
*
* If attribute remove="true" then add the element to list remove,
* else merge container attributes
*
* @param Layout\ScheduledStructure $scheduledStructure
* @param Layout\Element $currentElement
* @return void
*/
protected function containerReference(
Layout\ScheduledStructure $scheduledStructure,
Layout\Element $currentElement
) {
$containerName = $currentElement->getAttribute('name');
$containerRemove = filter_var($currentElement->getAttribute('remove'), FILTER_VALIDATE_BOOLEAN);
if ($containerRemove) {
$scheduledStructure->setElementToRemoveList($containerName);
return;
} elseif ($currentElement->getAttribute('remove')) {
$scheduledStructure->unsetElementFromListToRemove($containerName);
}
$this->mergeContainerAttributes($scheduledStructure, $currentElement);
}
}