1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace NatePage\EasyHtmlElement; |
4
|
|
|
|
5
|
|
|
use HtmlGenerator\HtmlTag; |
6
|
|
|
use HtmlGenerator\Markup; |
7
|
|
|
|
8
|
|
|
class Element implements ElementInterface |
9
|
|
|
{ |
10
|
|
|
/** @var string|null */ |
11
|
|
|
protected $type; |
12
|
|
|
|
13
|
|
|
/** @var string|null */ |
14
|
|
|
protected $text; |
15
|
|
|
|
16
|
|
|
/** @var array */ |
17
|
|
|
protected $attributes; |
18
|
|
|
|
19
|
|
|
/** @var array */ |
20
|
|
|
protected $extras; |
21
|
|
|
|
22
|
|
|
/** @var array */ |
23
|
|
|
protected $children; |
24
|
|
|
|
25
|
|
|
/** @var ElementInterface */ |
26
|
|
|
protected $parent; |
27
|
|
|
|
28
|
|
|
public function __construct( |
29
|
|
|
$type = null, |
30
|
|
|
$text = null, |
31
|
|
|
array $attributes = array(), |
32
|
|
|
array $extras = array(), |
33
|
|
|
array $children = array() |
34
|
|
|
) |
35
|
|
|
{ |
36
|
|
|
$this->setType($type); |
37
|
|
|
$this->setText($text); |
38
|
|
|
$this->setChildren($children); |
39
|
|
|
|
40
|
|
|
$this->attributes = $attributes; |
41
|
|
|
$this->extras = $extras; |
42
|
|
|
|
43
|
|
|
$this->init(); |
44
|
|
|
} |
45
|
|
|
|
46
|
|
|
/** |
47
|
|
|
* Use this method to customize element comportment. |
48
|
|
|
*/ |
49
|
|
|
protected function init(){} |
50
|
|
|
|
51
|
|
|
/** |
52
|
|
|
* {@inheritdoc} |
53
|
|
|
*/ |
54
|
|
|
public function __toString(): string |
55
|
|
|
{ |
56
|
|
|
return (string) $this->renderRoot(); |
57
|
|
|
} |
58
|
|
|
|
59
|
|
|
/** |
60
|
|
|
* {@inheritdoc} |
61
|
|
|
*/ |
62
|
|
|
public function renderRoot(): Markup |
63
|
|
|
{ |
64
|
|
|
return $this->getRoot()->render(); |
65
|
|
|
} |
66
|
|
|
|
67
|
|
|
/** |
68
|
|
|
* {@inheritdoc} |
69
|
|
|
*/ |
70
|
|
|
public function render(Markup $root = null): Markup |
71
|
|
|
{ |
72
|
|
|
$type = $this->type; |
73
|
|
|
$attributes = $this->attributes; |
74
|
|
|
|
75
|
|
|
$element = null === $root ? HtmlTag::createElement($type) : $root->addElement($type); |
76
|
|
|
$element->text($this->text); |
77
|
|
|
|
78
|
|
|
$this->renderAttributes($element, $attributes); |
79
|
|
|
$this->renderChildren($element); |
80
|
|
|
|
81
|
|
|
return $element; |
82
|
|
|
} |
83
|
|
|
|
84
|
|
|
/** |
85
|
|
|
* Set Markup element attributes. |
86
|
|
|
* |
87
|
|
|
* @param Markup $element |
88
|
|
|
* @param array $attributes |
89
|
|
|
*/ |
90
|
|
|
private function renderAttributes(Markup $element, array $attributes) |
91
|
|
|
{ |
92
|
|
|
foreach ($attributes as $attr => $value) { |
93
|
|
|
if (is_array($value)) { |
94
|
|
|
$glue = 'style' == $attr ? '; ' : ' '; |
95
|
|
|
$value = implode($glue, $value); |
96
|
|
|
} |
97
|
|
|
|
98
|
|
|
if (null !== $value) { |
99
|
|
|
$element->set($attr, $value); |
100
|
|
|
} |
101
|
|
|
} |
102
|
|
|
} |
103
|
|
|
|
104
|
|
|
/** |
105
|
|
|
* Render element children. |
106
|
|
|
* |
107
|
|
|
* @param Markup $root |
108
|
|
|
*/ |
109
|
|
|
private function renderChildren(Markup $root) |
110
|
|
|
{ |
111
|
|
|
foreach ($this->children as $child) { |
112
|
|
|
$child->render($root); |
113
|
|
|
} |
114
|
|
|
} |
115
|
|
|
|
116
|
|
|
/** |
117
|
|
|
* {@inheritdoc} |
118
|
|
|
*/ |
119
|
|
|
public function getType() |
120
|
|
|
{ |
121
|
|
|
return $this->type; |
122
|
|
|
} |
123
|
|
|
|
124
|
|
|
/** |
125
|
|
|
* {@inheritdoc} |
126
|
|
|
*/ |
127
|
|
|
public function setType($type = null): ElementInterface |
128
|
|
|
{ |
129
|
|
|
if (null !== $type) { |
130
|
|
|
$this->type = $type; |
131
|
|
|
} |
132
|
|
|
|
133
|
|
|
return $this; |
|
|
|
|
134
|
|
|
} |
135
|
|
|
|
136
|
|
|
/** |
137
|
|
|
* {@inheritdoc} |
138
|
|
|
*/ |
139
|
|
|
public function getText() |
140
|
|
|
{ |
141
|
|
|
return $this->text; |
142
|
|
|
} |
143
|
|
|
|
144
|
|
|
/** |
145
|
|
|
* {@inheritdoc} |
146
|
|
|
*/ |
147
|
|
|
public function setText($text = null): ElementInterface |
148
|
|
|
{ |
149
|
|
|
if (null !== $text) { |
150
|
|
|
$this->text = $text; |
151
|
|
|
} |
152
|
|
|
|
153
|
|
|
return $this; |
|
|
|
|
154
|
|
|
} |
155
|
|
|
|
156
|
|
|
/** |
157
|
|
|
* {@inheritdoc} |
158
|
|
|
*/ |
159
|
|
|
public function addAttributes(array $attributes): ElementInterface |
160
|
|
|
{ |
161
|
|
|
foreach ($attributes as $key => $value) { |
162
|
|
|
$this->addAttribute($key, $value); |
163
|
|
|
} |
164
|
|
|
|
165
|
|
|
return $this; |
|
|
|
|
166
|
|
|
} |
167
|
|
|
|
168
|
|
|
/** |
169
|
|
|
* {@inheritdoc} |
170
|
|
|
*/ |
171
|
|
|
public function addAttribute($key, $value): ElementInterface |
172
|
|
|
{ |
173
|
|
|
$this->attributes[$key] = $value; |
174
|
|
|
|
175
|
|
|
return $this; |
|
|
|
|
176
|
|
|
} |
177
|
|
|
|
178
|
|
|
/** |
179
|
|
|
* {@inheritdoc} |
180
|
|
|
*/ |
181
|
|
|
public function getAttribute(string $key) |
182
|
|
|
{ |
183
|
|
|
return isset($this->attributes[$key]) ? $this->attributes[$key] : null; |
184
|
|
|
} |
185
|
|
|
|
186
|
|
|
/** |
187
|
|
|
* {@inheritdoc} |
188
|
|
|
*/ |
189
|
|
|
public function getAttributes(): array |
190
|
|
|
{ |
191
|
|
|
return $this->attributes; |
192
|
|
|
} |
193
|
|
|
|
194
|
|
|
/** |
195
|
|
|
* {@inheritdoc} |
196
|
|
|
*/ |
197
|
|
|
public function setAttributes(array $attributes = array()): ElementInterface |
198
|
|
|
{ |
199
|
|
|
$this->attributes = $attributes; |
200
|
|
|
|
201
|
|
|
return $this; |
|
|
|
|
202
|
|
|
} |
203
|
|
|
|
204
|
|
|
/** |
205
|
|
|
* {@inheritdoc} |
206
|
|
|
*/ |
207
|
|
|
public function addChildren(array $children): ElementInterface |
208
|
|
|
{ |
209
|
|
|
foreach ($children as $child) { |
210
|
|
|
$this->addChild($child); |
211
|
|
|
} |
212
|
|
|
|
213
|
|
|
return $this; |
|
|
|
|
214
|
|
|
} |
215
|
|
|
|
216
|
|
|
/** |
217
|
|
|
* {@inheritdoc} |
218
|
|
|
*/ |
219
|
|
|
public function addChild(ElementInterface $child): ElementInterface |
220
|
|
|
{ |
221
|
|
|
$child = $child->getRoot(); |
222
|
|
|
|
223
|
|
|
$this->children[] = $child; |
224
|
|
|
|
225
|
|
|
$child->setParent($this); |
226
|
|
|
|
227
|
|
|
return $this; |
|
|
|
|
228
|
|
|
} |
229
|
|
|
|
230
|
|
|
/** |
231
|
|
|
* {@inheritdoc} |
232
|
|
|
*/ |
233
|
|
|
public function getChildren(): array |
234
|
|
|
{ |
235
|
|
|
return $this->children; |
236
|
|
|
} |
237
|
|
|
|
238
|
|
|
/** |
239
|
|
|
* {@inheritdoc} |
240
|
|
|
*/ |
241
|
|
|
public function setChildren(array $children = array()): ElementInterface |
242
|
|
|
{ |
243
|
|
|
$this->children = array(); |
244
|
|
|
|
245
|
|
|
$this->addChildren($children); |
246
|
|
|
|
247
|
|
|
return $this; |
|
|
|
|
248
|
|
|
} |
249
|
|
|
|
250
|
|
|
/** |
251
|
|
|
* {@inheritdoc} |
252
|
|
|
*/ |
253
|
|
|
public function getParent(): ElementInterface |
254
|
|
|
{ |
255
|
|
|
return $this->parent; |
256
|
|
|
} |
257
|
|
|
|
258
|
|
|
/** |
259
|
|
|
* {@inheritdoc} |
260
|
|
|
*/ |
261
|
|
|
public function setParent(ElementInterface $parent = null): ElementInterface |
262
|
|
|
{ |
263
|
|
|
$this->parent = $parent; |
264
|
|
|
|
265
|
|
|
return $this; |
|
|
|
|
266
|
|
|
} |
267
|
|
|
|
268
|
|
|
/** |
269
|
|
|
* {@inheritdoc} |
270
|
|
|
*/ |
271
|
|
|
public function getRoot(): ElementInterface |
272
|
|
|
{ |
273
|
|
|
return null !== $this->parent ? $this->parent->getRoot() : $this; |
274
|
|
|
} |
275
|
|
|
} |
276
|
|
|
|
If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.
Let’s take a look at an example:
Our function
my_function
expects aPost
object, and outputs the author of the post. The base classPost
returns a simple string and outputting a simple string will work just fine. However, the child classBlogPost
which is a sub-type ofPost
instead decided to return anobject
, and is therefore violating the SOLID principles. If aBlogPost
were passed tomy_function
, PHP would not complain, but ultimately fail when executing thestrtoupper
call in its body.