forked from jwage/purl
-
Notifications
You must be signed in to change notification settings - Fork 2
/
AbstractPart.php
283 lines (244 loc) · 4.62 KB
/
AbstractPart.php
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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
<?php
/*
* This file is part of the Purl package, a project by Jonathan H. Wage.
*
* (c) 2013 Jonathan H. Wage
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Purl;
/**
* AbstractPart class is implemented by each part of a Url where necessary.
*
* @author Jonathan H. Wage <jonwage@gmail.com>
* @implements ArrayAccess
*/
abstract class AbstractPart implements \ArrayAccess
{
/**
* Flag for whether or not this part has been initialized.
*
* @var boolean
*/
protected $initialized = false;
/**
* Array of data for this part.
*
* @var array
*/
protected $data = [];
/**
* Array mapping part names to classes.
*
* @var array
*/
protected $partClassMap = [];
/**
* Gets the data for this part. This method will initialize the part if it is not already initialized.
*
* @return array
*/
public function getData(): array
{
$this->initialize();
return $this->data;
}
/**
* Sets the data for this part. This method will initialize the part if it is not already initialized.
*
* @param array $data
*
* @return $this
*/
public function setData(array $data)
{
$this->initialize();
$this->data = $data;
foreach ($data as $key => $value) {
if (empty($value) && $value !== '0') {
unset($this->data[$key]);
}
}
return $this;
}
/**
* Check if this part has been initialized yet.
*
* @return boolean
*/
public function isInitialized(): bool
{
return $this->initialized;
}
/**
* Check if this part has data by key.
*
* @param string $key
*
* @return boolean
*/
public function has($key): bool
{
$this->initialize();
return isset($this->data[$key]);
}
/**
* Gets data from this part by key.
*
* @param string $key
*
* @return mixed|null
*/
public function get($key)
{
$this->initialize();
return $this->data[$key] ?? null;
}
/**
* Set data for this part by key.
*
* @param string $key
* @param mixed $value
*
* @return static
*/
public function set($key, $value)
{
$this->initialize();
$this->data[$key] = $value;
return $this;
}
/**
* Add data for this part.
*
* @param mixed $value
*
* @return $this
*/
public function add($value)
{
$this->initialize();
$this->data[] = $value;
return $this;
}
/**
* Remove data from this part by key.
*
* @param $key
*/
public function remove($key)
{
$this->initialize();
unset($this->data[$key]);
}
/** Property Overloading */
/**
* @param $key
*
* @return bool
*/
public function __isset($key)
{
return $this->has($key);
}
/**
* @param $key
*
* @return bool
*/
public function __get($key)
{
return $this->get($key);
}
/**
* @param $key
* @param $value
*
* @return AbstractPart
*/
public function __set($key, $value)
{
return $this->set($key, $value);
}
/**
* @param $key
*/
public function __unset($key)
{
return $this->remove($key);
}
/** ArrayAccess */
/**
* @param mixed $key
*
* @return bool
*/
public function offsetExists($key): bool
{
$this->initialize();
return isset($this->data[$key]);
}
/**
* @param mixed $key
*
* @return bool
*/
public function offsetGet($key): bool
{
return $this->get($key);
}
/**
* @param mixed $key
* @param mixed $value
*
* @return AbstractPart
*/
public function offsetSet($key, $value): self
{
return $this->set($key, $value);
}
/**
* @param mixed $key
*/
public function offsetUnset($key)
{
return $this->remove($key);
}
protected function initialize()
{
if ($this->initialized === true) {
return;
}
$this->initialized = true;
$this->doInitialize();
}
/**
* Prepare a part value.
*
* @param string $key
* @param string|static $value
*
* @return static
*/
protected function preparePartValue($key, &$value)
{
if (!isset($this->partClassMap[$key])) {
return $value;
}
$className = $this->partClassMap[$key];
return !$value instanceof $className ? new $className($value) : $value;
}
/**
* Convert the instance back in to string form from the internal parts.
*
* @return string
*/
abstract public function __toString();
/**
* Each part that extends AbstractPart must implement an doInitialize() method.
*
* @return void
*/
abstract protected function doInitialize();
}