-
-
Notifications
You must be signed in to change notification settings - Fork 9.4k
/
ArrayNode.php
483 lines (422 loc) · 14.4 KB
/
ArrayNode.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
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
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien.potencier@symfony-project.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Symfony\Component\Config\Definition;
use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
use Symfony\Component\Config\Definition\Exception\DuplicateKeyException;
use Symfony\Component\Config\Definition\Exception\InvalidTypeException;
use Symfony\Component\Config\Definition\Exception\UnsetKeyException;
use Symfony\Component\DependencyInjection\Extension\Extension;
/**
* Represents an ARRAY node in the config tree.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class ArrayNode extends BaseNode implements PrototypeNodeInterface
{
protected $xmlRemappings;
protected $children;
protected $prototype;
protected $keyAttribute;
protected $allowFalse;
protected $allowNewKeys;
protected $addIfNotSet;
protected $minNumberOfElements;
protected $performDeepMerging;
protected $defaultValue;
protected $allowUnnamedChildren;
/**
* Constructor.
*
* @param string $name The Node's name
* @param NodeInterface $parent The node parent
*/
public function __construct($name, NodeInterface $parent = null)
{
parent::__construct($name, $parent);
$this->children = array();
$this->xmlRemappings = array();
$this->allowFalse = false;
$this->addIfNotSet = false;
$this->allowNewKeys = true;
$this->performDeepMerging = true;
$this->minNumberOfElements = 0;
$this->allowUnnamedChildren = false;
}
/**
* Sets the xml remappings that should be performed.
*
* @param array $remappings an array of the form array(array(string, string))
* @return void
*/
public function setXmlRemappings(array $remappings)
{
$this->xmlRemappings = $remappings;
}
/**
* Sets the minimum number of elements that a prototype based node must
* contain. By default this is zero, meaning no elements.
*
* @param integer $number
* @return void
*/
public function setMinNumberOfElements($number)
{
$this->minNumberOfElements = $number;
}
/**
* The name of the attribute that should be used as key.
*
* This is only relevant for XML configurations, and only in combination
* with a prototype based node.
*
* @param string $attribute
* @return void
*/
public function setKeyAttribute($attribute)
{
$this->keyAttribute = $attribute;
}
/**
* Sets whether to add default values for this array if it has not been
* defined in any of the configuration files.
*
* @param Boolean $boolean
* @return void
*/
public function setAddIfNotSet($boolean)
{
$this->addIfNotSet = (Boolean) $boolean;
}
/**
* Sets whether false is allowed as value indicating that the array should
* be unset.
*
* @param Boolean $allow
* @return void
*/
public function setAllowFalse($allow)
{
$this->allowFalse = (Boolean) $allow;
}
/**
* Sets whether new keys can be defined in subsequent configurations.
*
* @param Boolean $allow
* @return void
*/
public function setAllowNewKeys($allow)
{
$this->allowNewKeys = (Boolean) $allow;
}
/**
* Sets if deep merging should occur.
*
* @param boolean $boolean
*/
public function setPerformDeepMerging($boolean)
{
$this->performDeepMerging = (Boolean) $boolean;
}
/**
* Sets the node Name.
*
* @param string $name The node's name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* Sets the default value of this node.
*
* @param string $value
* @throws \InvalidArgumentException if the default value is not an array
* @throws \RuntimeException if the node does not have a prototype
*/
public function setDefaultValue($value)
{
if (!is_array($value)) {
throw new \InvalidArgumentException($this->getPath().': the default value of an array node has to be an array.');
}
if (null === $this->prototype) {
throw new \RuntimeException($this->getPath().': An ARRAY node can have a specified default value only when using a prototype');
}
$this->defaultValue = $value;
}
/**
* Checks if the node has a default value.
*
* @return boolean
*/
public function hasDefaultValue()
{
if (null !== $this->prototype) {
return true;
}
return $this->addIfNotSet;
}
/**
* Retrieves the default value.
*
* @return array The default value
* @throws \RuntimeException if the node has no default value
*/
public function getDefaultValue()
{
if (!$this->hasDefaultValue()) {
throw new \RuntimeException(sprintf('The node at path "%s" has no default value.', $this->getPath()));
}
if (null !== $this->prototype) {
return $this->defaultValue ?: array();
}
$defaults = array();
foreach ($this->children as $name => $child) {
if (!$child->hasDefaultValue()) {
continue;
}
$defaults[$name] = $child->getDefaultValue();
}
return $defaults;
}
/**
* Sets the node prototype.
*
* @param PrototypeNodeInterface $node
* @throws \RuntimeException if the node doesnt have concrete children
*/
public function setPrototype(PrototypeNodeInterface $node)
{
if (count($this->children) > 0) {
throw new \RuntimeException($this->getPath().': An ARRAY node must either have concrete children, or a prototype node.');
}
$this->prototype = $node;
}
/**
* Adds a child node.
*
* @param NodeInterface $node The child node to add
* @throws \InvalidArgumentException when the child node has no name
* @throws \InvalidArgumentException when the child node's name is not unique
* @throws \RuntimeException if this array node is not a prototype
*/
public function addChild(NodeInterface $node)
{
$name = $node->getName();
if (empty($name)) {
throw new \InvalidArgumentException('Node name cannot be empty.');
}
if (isset($this->children[$name])) {
throw new \InvalidArgumentException(sprintf('The node "%s" already exists.', $name));
}
if (null !== $this->prototype) {
throw new \RuntimeException('An ARRAY node must either have a prototype, or concrete children.');
}
$this->children[$name] = $node;
}
/**
* Finalises the value of this node.
*
* @param mixed $value
* @return mixed The finalised value
* @throws UnsetKeyException
* @throws InvalidConfigurationException if the node doesnt have enough children
*/
protected function finalizeValue($value)
{
if (false === $value) {
throw new UnsetKeyException(sprintf(
'Unsetting key for path "%s", value: %s',
$this->getPath(),
json_encode($value)
));
}
if (null !== $this->prototype) {
foreach ($value as $k => $v) {
try {
$value[$k] = $this->prototype->finalize($v);
} catch (UnsetKeyException $unset) {
unset($value[$k]);
}
}
if (count($value) < $this->minNumberOfElements) {
throw new InvalidConfigurationException(sprintf(
'You must define at least %d element(s) for path "%s".',
$this->minNumberOfElements,
$this->getPath()
));
}
return $value;
}
foreach ($this->children as $name => $child) {
if (!array_key_exists($name, $value)) {
if ($child->isRequired()) {
throw new InvalidConfigurationException(sprintf(
'The node at path "%s" must be configured.',
$this->getPath().'.'.$name
));
}
if ($child->hasDefaultValue()) {
$value[$name] = $child->getDefaultValue();
}
continue;
}
try {
$value[$name] = $child->finalize($value[$name]);
} catch (UnsetKeyException $unset) {
unset($value[$name]);
}
}
// if extra fields are present and allowUnnamedChildren is false, throw exception
if (!$this->allowUnnamedChildren && $diff = array_diff(array_keys($value), array_keys($this->children))) {
$msg = sprintf('Unrecognized options "%s" under "%s"', implode(', ', $diff), $this->getPath());
throw new InvalidConfigurationException($msg);
}
return $value;
}
/**
* Validates the type of the value.
*
* @param mixed $value
* @throws InvalidTypeException
*/
protected function validateType($value)
{
if (!is_array($value) && (!$this->allowFalse || false !== $value)) {
throw new InvalidTypeException(sprintf(
'Invalid type for path "%s". Expected array, but got %s',
$this->getPath(),
json_encode($value)
));
}
}
/**
* Normalises the value.
*
* @param mixed $value The value to normalise
* @return mixed The normalised value
*/
protected function normalizeValue($value)
{
if (false === $value) {
return $value;
}
foreach ($this->xmlRemappings as $transformation) {
list($singular, $plural) = $transformation;
if (!isset($value[$singular])) {
continue;
}
$value[$plural] = Extension::normalizeConfig($value, $singular, $plural);
unset($value[$singular]);
}
if (null !== $this->prototype) {
$normalized = array();
foreach ($value as $k => $v) {
if (null !== $this->keyAttribute && is_array($v)) {
if (!isset($v[$this->keyAttribute]) && is_int($k)) {
throw new InvalidConfigurationException(sprintf(
'You must set a "%s" attribute for path "%s".',
$this->keyAttribute,
$this->getPath()
));
} else if (isset($v[$this->keyAttribute])) {
$k = $v[$this->keyAttribute];
unset($v[$this->keyAttribute]);
}
if (array_key_exists($k, $normalized)) {
throw new DuplicateKeyException(sprintf(
'Duplicate key "%s" for path "%s".',
$k,
$this->getPath()
));
}
}
$this->prototype->setName($k);
if (null !== $this->keyAttribute) {
$normalized[$k] = $this->prototype->normalize($v);
} else {
$normalized[] = $this->prototype->normalize($v);
}
}
return $normalized;
}
// note that this purposefully does not exclude unrecognized child keys.
// unrecognized keys are just added in - validation takes place in finalize
foreach ($this->children as $name => $child) {
if (!array_key_exists($name, $value)) {
continue;
}
$value[$name] = $child->normalize($value[$name]);
}
return $value;
}
/**
* Merges values together.
*
* @param mixed $leftSide The left side to merge.
* @param mixed $rightSide The right side to merge.
* @return mixed The merged values
* @throws InvalidConfigurationException
* @throws \RuntimeException
*/
protected function mergeValues($leftSide, $rightSide)
{
if (false === $rightSide) {
// if this is still false after the last config has been merged the
// finalization pass will take care of removing this key entirely
return false;
}
if (false === $leftSide || !$this->performDeepMerging) {
return $rightSide;
}
foreach ($rightSide as $k => $v) {
// prototype, and key is irrelevant, so simply append the element
if (null !== $this->prototype && null === $this->keyAttribute) {
$leftSide[] = $v;
continue;
}
// no conflict
if (!array_key_exists($k, $leftSide)) {
if (!$this->allowNewKeys) {
throw new InvalidConfigurationException(sprintf(
'You are not allowed to define new elements for path "%s". '
.'Please define all elements for this path in one config file.',
$this->getPath()
));
}
$leftSide[$k] = $v;
continue;
}
if (null !== $this->prototype) {
$this->prototype->setName($k);
$leftSide[$k] = $this->prototype->merge($leftSide[$k], $v);
} else {
if (!isset($this->children[$k])) {
throw new \RuntimeException('merge() expects a normalized config array.');
}
$leftSide[$k] = $this->children[$k]->merge($leftSide[$k], $v);
}
}
return $leftSide;
}
/**
* Set whether or not to allow this array to have child values that
* are not represented as nodes.
*
* An example would be an "options" array node, where its children
* could be any key of any form. In this case, no children are placed
* on the node, but child values must be allowed.
*
* @param Boolean $v Whether to allow unnamed children
*/
public function setAllowUnnamedChildren($v)
{
$this->allowUnnamedChildren = $v;
}
}