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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
|
<?php /** * Holds a bundle definition in a structure serializable to a native array. */ class Loco_config_ArrayModel extends Loco_config_Model {
/** * @var LocoConfigDocument */ private $dom;
/** * {@inheritdoc} */ public function createDom(){ $this->dom = new LocoConfigDocument( ['#document', [], [] ] ); }
/** * @return LocoConfigDocument */ public function getDom(){ return $this->dom; } /** * Construct model from serialized JSON * @return void */ public function loadJson( $json ){ $root = json_decode( $json, true ); if( ! $root || ! is_array($root) ){ throw new Loco_error_ParseException('Invalid JSON'); } $this->loadArray( $root ); } /** * Construct model from exported array * @return void */ public function loadArray( array $root ){ $dom = $this->getDom(); $dom->load( ['#document', [], [$root] ] ); }
/** * {@inheritdoc} * Emulates *very limited* XPath queries used by the XML DOM. */ public function query( $query, $context = null ){ $match = new LocoConfigNodeList; $query = explode('/', $query ); // absolute path always starts in document if( empty($query[0]) ){ $match->append( $this->getDom() ); } // else start with base for relative path else if( $context instanceof LocoConfigNode ){ $match->append( $context ); } while( $query ){ $name = array_shift($query); // self references do nothing if( ! $name || '.' === $name ){ continue; } // match all current branches to produce new set of parents $next = new LocoConfigNodeList; foreach( $match as $parent ){ foreach( $parent->childNodes as $child ){ if( $name === $child->nodeName || ( '*' === $name && $child instanceof LocoConfigElement ) || ( 'text()' === $name && $child instanceof LocoConfigText) ){ $next->append( $child ); } } } $match = $next; } return $match; } }
// The following classes are "private" to this file: // They partially implement the same interfaces as the core DOM classes and are used for code hints. // Interfaces are deliberately not used as the real DOM classes would not be able to implement them.
/** * Node * @property-read string $textContent * @property-read string $nodeName * @property-read LocoConfigNodeList $childNodes */ abstract class LocoConfigNode implements IteratorAggregate { /** * Raw data of internal format * @var array|string */ protected $data; /** * Child nodes once cast to node objects * @var LocoConfigNodeList */ protected $children;
/** * @return mixed */ abstract public function export();
/** * @param array|string $data */ final public function __construct( $data ){ $this->data = $data; }
/** * @internal */ protected function get_nodeName(){ return $this->data[0]; }
/** * @internal */ protected function get_childNodes(){ return $this->getIterator(); } public function __get( $prop ){ $method = [ $this, 'get_'.$prop ]; if( is_callable($method) ){ return call_user_func( $method ); } return null; }
/** @return LocoConfigNode */ public function appendChild( LocoConfigNode $child ){ $children = $this->getIterator(); $children->append( $child ); return $child; }
/** @return bool */ public function hasChildNodes(){ return (bool) count( $this->getIterator() ); } /** * @return LocoConfigNodeList */ #[ReturnTypeWillChange] public function getIterator(){ if( ! $this->children ){ //$raw = isset($this->data[2]) ? $this->data[2] : array(); $this->children = new LocoConfigNodeList( $this->data[2] ); } return $this->children; }
public function get_textContent(){ $s = ''; foreach( $this as $child ){ $s .= $child->get_textContent(); } return $s; } }
/** * NodeList */ class LocoConfigNodeList implements Iterator, Countable, ArrayAccess { private $nodes;
private $i;
private $n; public function __construct( array $nodes = [] ){ $this->nodes = $nodes; $this->n = count( $nodes ); }
#[ReturnTypeWillChange] public function count(){ return $this->n; }
#[ReturnTypeWillChange] public function rewind(){ $this->i = -1; $this->next(); }
#[ReturnTypeWillChange] public function key(){ return $this->i; }
#[ReturnTypeWillChange] public function current(){ return $this[ $this->i ]; }
#[ReturnTypeWillChange] public function valid(){ return is_int($this->i); }
#[ReturnTypeWillChange] public function next(){ if( ++$this->i === $this->n ){ $this->i = null; } }
#[ReturnTypeWillChange] public function offsetExists( $offset ){ return $offset >= 0 && $offset < $this->n; }
#[ReturnTypeWillChange] public function offsetGet( $offset ){ $node = $this->nodes[$offset]; if( ! $node instanceof LocoConfigNode ){ if( is_array($node) ){ $node = new LocoConfigElement( $node ); } else { $node = new LocoConfigText( $node ); } $this->nodes[$offset] = $node; } return $node; }
/** * @codeCoverageIgnore */ #[ReturnTypeWillChange] public function offsetSet( $offset, $value ){ throw new LogicException('Use append'); }
/** * @codeCoverageIgnore */ #[ReturnTypeWillChange] public function offsetUnset( $offset ){ throw new LogicException('Read only'); } public function append( LocoConfigNode $node ){ $this->nodes[] = $node; $this->n++; } /** * Revert nodes back to raw array form and return for exporting * @return array */ public function normalize(){ foreach( $this->nodes as $i => $node ){ if( $node instanceof LocoConfigNode ){ $this->nodes[$i] = $node->export(); } } return $this->nodes; } }
/** * Document * @property-read LocoConfigElement $documentElement */ class LocoConfigDocument extends LocoConfigNode {
/** * Rapidly set new data for document */ public function load( $data ){ $this->data = $data; $this->children = null; }
/** * @return LocoConfigElement */ public function createElement( $name ){ return new LocoConfigElement( [ $name, [], [] ] ); }
/** * @return LocoConfigText */ public function createTextNode( $text ){ return new LocoConfigText( $text ); }
/** * @return LocoConfigElement */ public function get_documentElement(){ $child = null; foreach( $this as $child ){ break; } return $child; }
/** * {@inheritdoc} * Override to keep single element root */ public function export(){ $root = $this->get_documentElement(); return $root ? $root->export() : null; } }
/** * Element */ class LocoConfigElement extends LocoConfigNode {
public function setAttribute( $prop, $value ){ $this->data[1][$prop] = $value; }
public function removeAttribute( $prop ){ unset( $this->data[1][$prop] ); }
public function getAttribute( $prop ){ if( isset($this->data[1][$prop]) ){ return $this->data[1][$prop]; } return ''; }
public function hasAttribute( $prop ){ return isset($this->data[1][$prop]); }
/** * {@inheritdoc} */ public function export(){ $raw = $this->data; // return any cast elements back to raw data if( $this->children ){ $raw[2] = $this->children->normalize(); } return $raw; } }
/** * Text node * @property-read string $nodeValue * @property-read string $textContent */ class LocoConfigText extends LocoConfigNode {
protected function get_nodeName(){ return '#text'; } public function hasChildNodes(){ return false; } public function getIterator(){ return new ArrayIterator; } public function export(){ return (string) $this->data; } /** @internal */ public function get_nodeValue(){ return (string) $this->data; }
/** @internal */ public function get_textContent(){ return (string) $this->data; } }
|