ArrayNodeDefinition

Sets the parent node.

Sets info message.

Sets example configuration.

Sets an attribute on the node.

Returns the parent node.

Creates the node.

Sets the default value.

Sets the node as required.

Sets the node as deprecated.

You can use %node% and %path% placeholders in your message to display, respectively, the node name and its complete path.

Sets the equivalent value used when the node contains null.

Sets the equivalent value used when the node contains true.

Sets the equivalent value used when the node contains false.

Sets null as the default value.

Sets true as the default value.

Sets false as the default value.

Sets an expression to run before the normalization.

Denies the node value being empty.

Sets an expression to run for the validation.

The expression receives the value of the node and must return it. It can modify it. An exception should be thrown when the node is not valid.

Sets whether the node can be overwritten.

Gets the builder for validation rules.

Gets the builder for merging rules.

Gets the builder for normalization rules.

Instantiate and configure the node according to this definition.

Set PathSeparator to use.

Sets a custom children builder.

Returns a builder to add children nodes.

Sets a prototype for child nodes.

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.

Adds children with a default value when none are defined.

This method is applicable to prototype nodes only.

Requires the node to have at least one element.

This method is applicable to prototype nodes only.

Disallows adding news keys in a subsequent configuration.

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

Sets a normalization rule for XML configurations.

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.

This method is applicable to prototype nodes only.

Sets whether the node can be unset.

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

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

By default, the section is enabled.

Disables the deep merging of the node.

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

Those config values are simply 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.

Sets key normalization.

Appends a node definition.

Usage:

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

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

Validate the configuration of a concrete node.

Validate the configuration of a prototype node.