Container.php
3.81 KB
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
<?php
namespace YahnisElsts\AdminMenuEditor\Customizable\Controls;
abstract class Container extends UiElement implements \IteratorAggregate, ControlContainer {
/**
* @var UiElement[]
*/
protected $children = [];
/**
* @var string
*/
protected $title = '';
/**
* @var null|\YahnisElsts\AdminMenuEditor\Customizable\Controls\Tooltip
*/
protected $tooltip = null;
public function __construct($title, $children = [], $params = []) {
parent::__construct($params);
$this->title = $title;
foreach ($children as $child) {
$this->add($child);
}
if ( isset($params['tooltip']) ) {
$this->tooltip = $params['tooltip'];
}
}
/**
* @param UiElement $child
* @return void
*/
public function add($child) {
$this->children[] = $child;
}
/**
* @return UiElement[]
*/
public function getChildren() {
return $this->children;
}
/**
* Sort the container's children using the specified comparison function.
*
* @param callable(UiElement,UiElement):int $compareFunction
* @return void
*/
public function sortChildren($compareFunction) {
usort($this->children, $compareFunction);
}
/**
* Recursively filter the container's children using the specified callback.
*
* The children list is replaced with the filtered list.
*
* @param callable(UiElement):bool $callback
* @return void
*/
public function recursiveFilterChildrenInPlace($callback) {
foreach ($this->children as $key => $child) {
//Depth-first traversal.
if ( $child instanceof Container ) {
$child->recursiveFilterChildrenInPlace($callback);
}
if ( $callback($child) === false ) {
unset($this->children[$key]);
}
}
//Re-index the array. Note: array_filter() would not help much since it does not re-index the array.
$this->children = array_values($this->children);
}
/**
* @return string
*/
public function getTitle() {
return $this->title;
}
/**
* @param string $newTitle
*/
public function setTitle($newTitle) {
$this->title = $newTitle;
}
public function hasTitle() {
return !empty($this->title);
}
/**
* @return \YahnisElsts\AdminMenuEditor\Customizable\Controls\Tooltip|null
*/
public function getTooltip() {
return $this->tooltip;
}
/**
* @return bool
*/
public function hasTooltip() {
return ($this->tooltip !== null);
}
/**
* Recursively search the container for a UI element that has the specified ID.
*
* @param string $id
* @return UiElement|null
*/
public function findChildById($id) {
foreach ($this->children as $child) {
if ( $child->getId() === $id ) {
return $child;
} else if ( $child instanceof Container ) {
$result = $child->findChildById($id);
if ( $result !== null ) {
return $result;
}
}
}
return null;
}
public function isEmpty() {
return empty($this->children);
}
public function hasChildren() {
return !empty($this->children);
}
public function serializeForJs() {
$result = parent::serializeForJs();
if ( $this->hasTitle() ) {
$result['title'] = $this->title;
}
if ( !empty($this->children) ) {
$result['children'] = [];
foreach ($this->children as $child) {
$result['children'][] = $child->serializeForJs();
}
}
return $result;
}
public function enqueueKoComponentDependencies() {
parent::enqueueKoComponentDependencies();
foreach ($this->children as $child) {
$child->enqueueKoComponentDependencies();
}
}
/** @noinspection PhpLanguageLevelInspection */
#[\ReturnTypeWillChange]
public function getIterator() {
return new \ArrayIterator($this->children);
}
/**
* Recursively get all descendants of this container.
*
* @return \Generator
*/
public function getAllDescendants() {
foreach ($this->children as $child) {
yield $child;
if ( $child instanceof ControlContainer ) {
yield from $child->getAllDescendants();
}
}
}
}