Symfony\Component\Config\Definition\PrototypedArrayNode

class PrototypedArrayNode extends ArrayNode

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)	from ArrayNode
array	getChildren() Retrieves the children of this node.	from ArrayNode
	setXmlRemappings(array $remappings) Sets the xml remappings that should be performed.	from ArrayNode
array	getXmlRemappings() Gets the xml remappings that should be performed.	from ArrayNode
	setAddIfNotSet(bool $boolean) Sets whether to add default values for this array if it has not been defined in any of the configuration files.	from ArrayNode
	setAllowFalse(bool $allow) Sets whether false is allowed as value indicating that the array should be unset.	from ArrayNode
	setAllowNewKeys(bool $allow) Sets whether new keys can be defined in subsequent configurations.	from ArrayNode
	setPerformDeepMerging(bool $boolean) Sets if deep merging should occur.	from ArrayNode
	setIgnoreExtraKeys(bool $boolean, bool $remove = true) Whether extra keys should just be ignore without an exception.	from ArrayNode
	setName(string $name) Sets the node Name.	from ArrayNode
bool	hasDefaultValue() Checks if the node has a default value.
array	getDefaultValue() Retrieves the default value.
	addChild(NodeInterface $node) Disable adding concrete children for prototyped nodes.
	setMinNumberOfElements(int $number) Sets the minimum number of elements that a prototype based node must contain.
	setKeyAttribute(string $attribute, bool $remove = true) Sets the attribute which value is to be used as key.
string	getKeyAttribute() Retrieves the name of the attribute which value should be used as key.
	setDefaultValue(string $value) Sets the default value of this node.
	setAddChildrenIfNoneSet(int|string|array|null $children = array('defaults')) Adds default children when none are set.
	setPrototype(PrototypeNodeInterface $node) Sets the node prototype.
PrototypeNodeInterface	getPrototype() Retrieves the prototype.

Details

public __construct(string $name, NodeInterface $parent = null)

Constructor.

public setAttribute($key, $value)

public getAttribute($key, $default = null)

public hasAttribute($key)

public getAttributes()

public setAttributes(array $attributes)

public removeAttribute($key)

public setInfo(string $info)

Sets an info message.

public string getInfo()

Returns info message.

public setExample(string|array $example)

Sets the example configuration for this node.

public string|array getExample()

Retrieves the example configuration for this node.

public addEquivalentValue(mixed $originalValue, mixed $equivalentValue)

Adds an equivalent value.

public setRequired(bool $boolean)

Set this node as required.

public setAllowOverwrite(bool $allow)

Sets if this node can be overridden.

public setNormalizationClosures(array $closures)

Sets the closures used for normalization.

public setFinalValidationClosures(array $closures)

Sets the closures used for final validation.

public bool isRequired()

Checks if this node is required.

public string getName()

Returns the name of this node.

public string getPath()

Retrieves the path of this node.

final public mixed merge(mixed $leftSide, mixed $rightSide)

Merges two values together.

final public mixed normalize(mixed $value)

Normalizes a value, applying all normalization closures.

public NodeInterface|null getParent()

Returns parent node for this node.

final public mixed finalize(mixed $value)

Finalizes a value, applying all finalization closures.

public setNormalizeKeys($normalizeKeys)

public array getChildren()

Retrieves the children of this node.

public setXmlRemappings(array $remappings)

Sets the xml remappings that should be performed.

public array getXmlRemappings()

Gets the xml remappings that should be performed.

public setAddIfNotSet(bool $boolean)

Sets whether to add default values for this array if it has not been defined in any of the configuration files.

public setAllowFalse(bool $allow)

Sets whether false is allowed as value indicating that the array should be unset.

public setAllowNewKeys(bool $allow)

Sets whether new keys can be defined in subsequent configurations.

public setPerformDeepMerging(bool $boolean)

Sets if deep merging should occur.

public setIgnoreExtraKeys(bool $boolean, bool $remove = true)

Whether extra keys should just be ignore without an exception.

public setName(string $name)

Sets the node Name.

public bool hasDefaultValue()

Checks if the node has a default value.

public array getDefaultValue()

Retrieves the default value.

The default value could be either explicited or derived from the prototype default value.

public addChild(NodeInterface $node)

Disable adding concrete children for prototyped nodes.

public setMinNumberOfElements(int $number)

Sets the minimum number of elements that a prototype based node must contain.

By default this is zero, meaning no elements.

public setKeyAttribute(string $attribute, bool $remove = true)

Sets the attribute which value is to be used as key.

This is useful when you have an indexed array that should be an associative array. You can select an item from within the array to be the key of the particular item. For example, if "id" is the "key", then:

array(
    array('id' => 'my_name', 'foo' => 'bar'),
);

becomes

 array(
     'my_name' => array('foo' => 'bar'),
 );

If you'd like "'id' => 'my_name'" to still be present in the resulting array, then you can set the second argument of this method to false.

public string getKeyAttribute()

Retrieves the name of the attribute which value should be used as key.

public setDefaultValue(string $value)

Sets the default value of this node.

public setAddChildrenIfNoneSet(int|string|array|null $children = array('defaults'))

Adds default children when none are set.

public setPrototype(PrototypeNodeInterface $node)

Sets the node prototype.

public PrototypeNodeInterface getPrototype()

Retrieves the prototype.