ArrayNode
class ArrayNode extends BaseNode implements PrototypeNodeInterface
Represents an Array node in the config tree.
Methods
Adds an equivalent value.
Sets the closures used for final validation.
Normalizes a value, applying all normalization closures.
No description
Retrieves the children of this node.
Sets the xml remappings that should be performed.
Gets the xml remappings that should be performed.
Sets whether to add default values for this array if it has not been defined in any of the configuration files.
Sets whether false is allowed as value indicating that the array should be unset.
Sets whether new keys can be defined in subsequent configurations.
Sets if deep merging should occur.
Whether extra keys should just be ignore without an exception.
Sets the node Name.
Checks if the node has a default value.
Retrieves the default value.
Details
in BaseNode at line line 43
__construct(string $name, NodeInterface $parent = null)
Constructor.
in BaseNode at line line 53
setAttribute($key, $value)
in BaseNode at line line 58
getAttribute($key, $default = null)
in BaseNode at line line 63
hasAttribute($key)
in BaseNode at line line 68
getAttributes()
in BaseNode at line line 73
setAttributes(array $attributes)
in BaseNode at line line 78
removeAttribute($key)
in BaseNode at line line 88
setInfo(string $info)
Sets an info message.
in BaseNode at line line 98
string
getInfo()
Returns info message.
in BaseNode at line line 108
setExample(string|array $example)
Sets the example configuration for this node.
in BaseNode at line line 118
string|array
getExample()
Retrieves the example configuration for this node.
in BaseNode at line line 129
addEquivalentValue(mixed $originalValue, mixed $equivalentValue)
Adds an equivalent value.
in BaseNode at line line 139
setRequired(bool $boolean)
Set this node as required.
in BaseNode at line line 149
setAllowOverwrite(bool $allow)
Sets if this node can be overridden.
in BaseNode at line line 159
setNormalizationClosures(array $closures)
Sets the closures used for normalization.
in BaseNode at line line 169
setFinalValidationClosures(array $closures)
Sets the closures used for final validation.
in BaseNode at line line 179
bool
isRequired()
Checks if this node is required.
in BaseNode at line line 189
string
getName()
Returns the name of this node.
in BaseNode at line line 199
string
getPath()
Retrieves the path of this node.
in BaseNode at line line 220
final mixed
merge(mixed $leftSide, mixed $rightSide)
Merges two values together.
in BaseNode at line line 244
final mixed
normalize(mixed $value)
Normalizes a value, applying all normalization closures.
in BaseNode at line line 284
NodeInterface|null
getParent()
Returns parent node for this node.
in BaseNode at line line 299
final mixed
finalize(mixed $value)
Finalizes a value, applying all finalization closures.
at line line 35
setNormalizeKeys($normalizeKeys)
at line line 74
array
getChildren()
Retrieves the children of this node.
at line line 84
setXmlRemappings(array $remappings)
Sets the xml remappings that should be performed.
at line line 94
array
getXmlRemappings()
Gets the xml remappings that should be performed.
at line line 105
setAddIfNotSet(bool $boolean)
Sets whether to add default values for this array if it has not been defined in any of the configuration files.
at line line 115
setAllowFalse(bool $allow)
Sets whether false is allowed as value indicating that the array should be unset.
at line line 125
setAllowNewKeys(bool $allow)
Sets whether new keys can be defined in subsequent configurations.
at line line 135
setPerformDeepMerging(bool $boolean)
Sets if deep merging should occur.
at line line 146
setIgnoreExtraKeys(bool $boolean, bool $remove = true)
Whether extra keys should just be ignore without an exception.
at line line 157
setName(string $name)
Sets the node Name.
at line line 167
bool
hasDefaultValue()
Checks if the node has a default value.
at line line 179
mixed
getDefaultValue()
Retrieves the default value.
at line line 203
addChild(NodeInterface $node)
Adds a child node.