Class Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition

`extends`	`NodeDefinition`
`implements`	`ParentNodeDefinitionInterface`

This class provides a fluent interface for defining an array node.

Symfony\Component\Config\Definition\Builder\NodeDefinition implements NodeParentInterface
- Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition implements ParentNodeDefinitionInterface

Methods


					
	public

__construct(?string $name, NodeParentInterface $parent = null)

Overrides

Symfony\Component\Config\Definition\Builder\NodeDefinition::__construct()


					
	public

setBuilder(NodeBuilder $builder): void

Sets a custom children builder.

Implements

Symfony\Component\Config\Definition\Builder\BuilderAwareInterface::setBuilder()


					
	public

children(): NodeBuilder

Returns a builder to add children nodes.

Implements

Symfony\Component\Config\Definition\Builder\ParentNodeDefinitionInterface::children()


					
	public

prototype(string $type): NodeDefinition

Sets a prototype for child nodes.


					
	public

variablePrototype(): VariableNodeDefinition


					
	public

scalarPrototype(): ScalarNodeDefinition


					
	public

booleanPrototype(): BooleanNodeDefinition


					
	public

integerPrototype(): IntegerNodeDefinition


					
	public

floatPrototype(): FloatNodeDefinition


					
	public

arrayPrototype(): self


					
	public

enumPrototype(): EnumNodeDefinition


					
	public

addDefaultsIfNotSet(): $this

Adds the default value if the node is not set in the configuration.

This method is applicable to concrete nodes only (not to prototype nodes). If this function has been called and the node is not set during the finalization phase, it's default value will be derived from its children default values.


					
	public

addDefaultChildrenIfNoneSet(int|string|array|null $children = null): $this

Adds children with a default value when none are defined.

This method is applicable to prototype nodes only.

Parameters

$children

The number of children|The child name|The children names to be added


					
	public

requiresAtLeastOneElement(): $this

Requires the node to have at least one element.

This method is applicable to prototype nodes only.


					
	public

disallowNewKeysInSubsequentConfigs(): $this

Disallows adding news keys in a subsequent configuration.

If used all keys have to be defined in the same configuration file.


					
	public

fixXmlConfig(string $singular, string|null $plural = null): $this

Sets a normalization rule for XML configurations.

Parameters

`$singular`	The key to remap
`$plural`	The plural of the key for irregular plurals


					
	public

useAttributeAsKey(string $name, bool $removeKeyItem = true): $this

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:

[ ['id' => 'my_name', 'foo' => 'bar'], ];

becomes

[ 'my_name' => ['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.

This method is applicable to prototype nodes only.

Parameters

`$name`	The name of the key
`$removeKeyItem`	Whether or not the key item should be removed


					
	public

canBeUnset(bool $allow = true): $this

Sets whether the node can be unset.


					
	public

canBeEnabled(): $this

Adds an "enabled" boolean to enable the current section.

By default, the section is disabled. If any configuration is specified then the node will be automatically enabled:

enableableArrayNode: {enabled: true, ...} # The config is enabled & default values get overridden enableableArrayNode: ~ # The config is enabled & use the default values enableableArrayNode: true # The config is enabled & use the default values enableableArrayNode: {other: value, ...} # The config is enabled & default values get overridden enableableArrayNode: {enabled: false, ...} # The config is disabled enableableArrayNode: false # The config is disabled


					
	public

canBeDisabled(): $this

Adds an "enabled" boolean to enable the current section.

By default, the section is enabled.


					
	public

performNoDeepMerging(): $this

Disables the deep merging of the node.


					
	public

ignoreExtraKeys(bool $remove = true): $this

Allows extra config keys to be specified under an array without throwing an exception.

Those config values are ignored and removed from the resulting array. This should be used only in special cases where you want to send an entire configuration array through a special tree that processes only part of the array.

Parameters

$remove

Whether to remove the extra keys


					
	public

normalizeKeys(bool $bool): $this

Sets whether to enable key normalization.


					
	public

append(NodeDefinition $node): static

Appends a node definition.

Usage:

$node = $parentNode ->children() ->scalarNode('foo')->end() ->scalarNode('baz')->end() ->append($this->getBarNodeDefinition()) ->end() ;

Implements

Symfony\Component\Config\Definition\Builder\ParentNodeDefinitionInterface::append()


					
	protected

getNodeBuilder(): NodeBuilder

Returns a node builder to be used to add children and prototype.


					
	protected

createNode(): NodeInterface

Instantiate and configure the node according to this definition.

Implements

Symfony\Component\Config\Definition\Builder\NodeDefinition::createNode()


					
	protected

validateConcreteNode(ArrayNode $node): void

Validate the configuration of a concrete node.

Throws

Symfony\Component\Config\Definition\Exception\InvalidDefinitionException


					
	protected

validatePrototypeNode(PrototypedArrayNode $node): void

Validate the configuration of a prototype node.

Throws

Symfony\Component\Config\Definition\Exception\InvalidDefinitionException


					
	public

getChildNodeDefinitions(): NodeDefinition[]

Gets the child node definitions.

Implements

Symfony\Component\Config\Definition\Builder\ParentNodeDefinitionInterface::getChildNodeDefinitions()


					
	public

find(string $nodePath): NodeDefinition

Finds a node defined by the given $nodePath.

Parameters

$nodePath

The path of the node to find. e.g "doctrine.orm.mappings"

Methods inherited from Symfony\Component\Config\Definition\Builder\NodeDefinition
`setParent(), info(), example(), attribute(), end(), getNode(), defaultValue(), isRequired(), setDeprecated(), treatNullLike(), treatTrueLike(), treatFalseLike(), defaultNull(), defaultTrue(), defaultFalse(), beforeNormalization(), cannotBeEmpty(), validate(), cannotBeOverwritten(), validation(), merge(), normalization(), setPathSeparator()`

Properties
`protected`	`$performDeepMerging = true`	#
`protected`	`$ignoreExtraKeys = false`	#
`protected`	`$removeExtraKeys = true`	#
`protected`	`$children = []`	#
`protected`	`$prototype`	#
`protected`	`$atLeastOne = false`	#
`protected`	`$allowNewKeys = true`	#
`protected`	`$key`	#
`protected`	`$removeKeyItem`	#
`protected`	`$addDefaults = false`	#
`protected`	`$addDefaultChildren = false`	#
`protected`	`$nodeBuilder`	#
`protected`	`$normalizeKeys = true`	#

Properties inherited from Symfony\Component\Config\Definition\Builder\NodeDefinition
`$name, $normalization, $validation, $defaultValue, $default, $required, $deprecation, $merge, $allowEmptyValue, $nullEquivalent, $trueEquivalent, $falseEquivalent, $pathSeparator, $parent, $attributes`

Namespaces

Classes

Interfaces

Class Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition

Overrides

Implements

Implements

Parameters

Parameters

Parameters

Parameters

Implements

Implements

Throws

Throws

Implements

Parameters