Symfony\Component\Config\Definition\PrototypedArrayNode
Represents a prototyped Array node in the config tree.
- Author: Johannes M. Schmitt <schmittjoh@gmail.com>
Synopsis
class PrototypedArrayNode
extends ArrayNode
{
- // members
- protected $prototype;
- protected $keyAttribute;
- protected $removeKeyAttribute;
- protected $minNumberOfElements;
- protected $defaultValue;
- protected $defaultChildren;
- // Inherited members from ArrayNode
- protected $xmlRemappings;
- protected $children;
- protected $allowFalse;
- protected $allowNewKeys;
- protected $addIfNotSet;
- protected $performDeepMerging;
- protected $ignoreExtraKeys;
- protected $normalizeKeys;
- // Inherited members from BaseNode
- protected $name;
- protected $parent;
- protected $normalizationClosures;
- protected $finalValidationClosures;
- protected $allowOverwrite;
- protected $required;
- protected $equivalentValues;
- protected array $attributes;
- // methods
- public void __construct()
- public void setMinNumberOfElements()
- public void setKeyAttribute()
- public string getKeyAttribute()
- public void setDefaultValue()
- public Boolean hasDefaultValue()
- public void setAddChildrenIfNoneSet()
- public array getDefaultValue()
- public void setPrototype()
- public PrototypeNodeInterface getPrototype()
- public void addChild()
- protected mixed finalizeValue()
- protected mixed normalizeValue()
- protected mixed mergeValues()
- // Inherited methods from ArrayNode
- public void __construct()
- public void setNormalizeKeys()
- protected array preNormalize()
- public array getChildren()
- public void setXmlRemappings()
- public void setAddIfNotSet()
- public void setAllowFalse()
- public void setAllowNewKeys()
- public void setPerformDeepMerging()
- public void setIgnoreExtraKeys()
- public void setName()
- public Boolean hasDefaultValue()
- public array getDefaultValue()
- public void addChild()
- protected mixed finalizeValue()
- protected void validateType()
- protected mixed normalizeValue()
- protected array remapXml()
- protected mixed mergeValues()
- // Inherited methods from BaseNode
- public void __construct()
- public void setAttribute()
- public void getAttribute()
- public void hasAttribute()
- public void getAttributes()
- public void setAttributes()
- public void removeAttribute()
- public void setInfo()
- public string getInfo()
- public void setExample()
- public string|array getExample()
- public void addEquivalentValue()
- public void setRequired()
- public void setAllowOverwrite()
- public void setNormalizationClosures()
- public void setFinalValidationClosures()
- public Boolean isRequired()
- public string getName()
- public string getPath()
- public final mixed merge()
- public final mixed normalize()
- protected $value preNormalize()
- public final mixed finalize()
- protected abstract void validateType()
- protected abstract mixed normalizeValue()
- protected abstract mixed mergeValues()
- protected abstract mixed finalizeValue()
Hierarchy
Members
protected
- $addIfNotSet
- $allowFalse
- $allowNewKeys
- $allowOverwrite
- $attributes
- $children
- $defaultChildren
- $defaultValue
- $equivalentValues
- $finalValidationClosures
- $ignoreExtraKeys
- $keyAttribute
- $minNumberOfElements
- $name
- $normalizationClosures
- $normalizeKeys
- $parent
- $performDeepMerging
- $prototype
- $removeKeyAttribute
- $required
- $xmlRemappings
Methods
protected
- finalizeValue() — Finalizes the value of this node.
- mergeValues() — Merges values together.
- normalizeValue() — Normalizes the value.
public
- __construct() — Constructor.
- addChild() — Disable adding concrete children for prototyped nodes.
- getDefaultValue() — Retrieves the default value.
- getKeyAttribute() — Retrieves the name of the attribute which value should be used as key.
- getPrototype() — Retrieves the prototype
- hasDefaultValue() — Checks if the node has a default value.
- setAddChildrenIfNoneSet() — Adds default children when none are set.
- setDefaultValue() — Sets the default value of this node.
- setKeyAttribute() — Sets the attribute which value is to be used as key.
- setMinNumberOfElements() — Sets the minimum number of elements that a prototype based node must contain. By default this is zero, meaning no elements.
- setPrototype() — Sets the node prototype.
Inherited from Symfony\Component\Config\Definition\ArrayNode
protected
- finalizeValue() — Finalizes the value of this node.
- mergeValues() — Merges values together.
- normalizeValue() — Normalizes the value.
- preNormalize() — Normalizes keys between the different configuration formats.
- remapXml() — Remaps multiple singular values to a single plural value.
- validateType() — Validates the type of the value.
public
- addChild() — Adds a child node.
- getChildren() — Retrieves the children of this node.
- getDefaultValue() — Retrieves the default value.
- hasDefaultValue() — Checks if the node has a default value.
- setAddIfNotSet() — Sets whether to add default values for this array if it has not been defined in any of the configuration files.
- setAllowFalse() — Sets whether false is allowed as value indicating that the array should be unset.
- setAllowNewKeys() — Sets whether new keys can be defined in subsequent configurations.
- setIgnoreExtraKeys() — Whether extra keys should just be ignore without an exception.
- setName() — Sets the node Name.
- setNormalizeKeys()
- setPerformDeepMerging() — Sets if deep merging should occur.
- setXmlRemappings() — Sets the xml remappings that should be performed.
Inherited from Symfony\Component\Config\Definition\BaseNode
protected
- finalizeValue() — Finalizes a value.
- mergeValues() — Merges two values together.
- normalizeValue() — Normalizes the value.
- preNormalize() — Normalizes the value before any other normalization is applied.
- validateType() — Validates the type of a Node.
public
- addEquivalentValue() — Adds an equivalent value.
- finalize() — Finalizes a value, applying all finalization closures.
- getAttribute()
- getAttributes()
- getExample() — Retrieves the example configuration for this node.
- getInfo() — Returns info message.
- getName() — Returns the name of this node
- getPath() — Retrieves the path of this node.
- hasAttribute()
- isRequired() — Checks if this node is required.
- merge() — Merges two values together.
- normalize() — Normalizes a value, applying all normalization closures.
- removeAttribute()
- setAllowOverwrite() — Sets if this node can be overridden.
- setAttribute()
- setAttributes()
- setExample() — Sets the example configuration for this node.
- setFinalValidationClosures() — Sets the closures used for final validation.
- setInfo() — Sets an info message.
- setNormalizationClosures() — Sets the closures used for normalization.
- setRequired() — Set this node as required.