class ArrayNode extends BaseNode implements PrototypeNodeInterface
Represents an Array node in the config tree.
Methods
__construct(string $name, NodeInterface $parent = null) Constructor. | from BaseNode | |
setAttribute($key, $value) | from BaseNode | |
getAttribute($key, $default = null) | from BaseNode | |
hasAttribute($key) | from BaseNode | |
getAttributes() | from BaseNode | |
setAttributes(array $attributes) | from BaseNode | |
removeAttribute($key) | from BaseNode | |
setInfo(string $info) Sets an info message. | from BaseNode | |
string | getInfo() Returns info message. | from BaseNode |
setExample(string|array $example) Sets the example configuration for this node. | from BaseNode | |
string|array | getExample() Retrieves the example configuration for this node. | from BaseNode |
addEquivalentValue(mixed $originalValue, mixed $equivalentValue) Adds an equivalent value. | from BaseNode | |
setRequired(bool $boolean) Set this node as required. | from BaseNode | |
setAllowOverwrite(bool $allow) Sets if this node can be overridden. | from BaseNode | |
setNormalizationClosures(array $closures) Sets the closures used for normalization. | from BaseNode | |
setFinalValidationClosures(array $closures) Sets the closures used for final validation. | from BaseNode | |
bool | isRequired() Checks if this node is required. | from BaseNode |
string | getName() Returns the name of this node. | from BaseNode |
string | getPath() Retrieves the path of this node. | from BaseNode |
mixed | merge(mixed $leftSide, mixed $rightSide) Merges two values together. | from BaseNode |
mixed | normalize(mixed $value) Normalizes a value, applying all normalization closures. | from BaseNode |
NodeInterface|null | getParent() Returns parent node for this node. | from BaseNode |
mixed | finalize(mixed $value) Finalizes a value, applying all finalization closures. | from BaseNode |
setNormalizeKeys($normalizeKeys) | ||
array | getChildren() Retrieves the children of this node. | |
setXmlRemappings(array $remappings) Sets the xml remappings that should be performed. | ||
array | getXmlRemappings() Gets the xml remappings that should be performed. | |
setAddIfNotSet(bool $boolean) Sets whether to add default values for this array if it has not been defined in any of the configuration files. | ||
setAllowFalse(bool $allow) Sets whether false is allowed as value indicating that the array should be unset. | ||
setAllowNewKeys(bool $allow) Sets whether new keys can be defined in subsequent configurations. | ||
setPerformDeepMerging(bool $boolean) Sets if deep merging should occur. | ||
setIgnoreExtraKeys(bool $boolean, bool $remove = true) Whether extra keys should just be ignore without an exception. | ||
setName(string $name) Sets the node Name. | ||
bool | hasDefaultValue() Checks if the node has a default value. | |
mixed | getDefaultValue() Retrieves the default value. | |
addChild(NodeInterface $node) Adds a child node. |
Details
__construct(string $name, NodeInterface $parent = null)
Constructor.
setAttribute($key, $value)
getAttribute($key, $default = null)
hasAttribute($key)
getAttributes()
setAttributes(array $attributes)
removeAttribute($key)
setInfo(string $info)
Sets an info message.
string getInfo()
Returns info message.
setExample(string|array $example)
Sets the example configuration for this node.
string|array getExample()
Retrieves the example configuration for this node.
addEquivalentValue(mixed $originalValue, mixed $equivalentValue)
Adds an equivalent value.
setRequired(bool $boolean)
Set this node as required.
setAllowOverwrite(bool $allow)
Sets if this node can be overridden.
setNormalizationClosures(array $closures)
Sets the closures used for normalization.
setFinalValidationClosures(array $closures)
Sets the closures used for final validation.
bool isRequired()
Checks if this node is required.
string getName()
Returns the name of this node.
string getPath()
Retrieves the path of this node.
final mixed merge(mixed $leftSide, mixed $rightSide)
Merges two values together.
final mixed normalize(mixed $value)
Normalizes a value, applying all normalization closures.
NodeInterface|null getParent()
Returns parent node for this node.
final mixed finalize(mixed $value)
Finalizes a value, applying all finalization closures.
setNormalizeKeys($normalizeKeys)
array getChildren()
Retrieves the children of this node.
setXmlRemappings(array $remappings)
Sets the xml remappings that should be performed.
array getXmlRemappings()
Gets the xml remappings that should be performed.
setAddIfNotSet(bool $boolean)
Sets whether to add default values for this array if it has not been defined in any of the configuration files.
setAllowFalse(bool $allow)
Sets whether false is allowed as value indicating that the array should be unset.
setAllowNewKeys(bool $allow)
Sets whether new keys can be defined in subsequent configurations.
setPerformDeepMerging(bool $boolean)
Sets if deep merging should occur.
setIgnoreExtraKeys(bool $boolean, bool $remove = true)
Whether extra keys should just be ignore without an exception.
setName(string $name)
Sets the node Name.
bool hasDefaultValue()
Checks if the node has a default value.
mixed getDefaultValue()
Retrieves the default value.
addChild(NodeInterface $node)
Adds a child node.
Please login to continue.