Class NodeDefinition

This class provides a fluent interface for defining a node.

Symfony\Component\Config\Definition\Builder\NodeDefinition implements Symfony\Component\Config\Definition\Builder\NodeParentInterface

Direct known subclasses

Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition, Symfony\Component\Config\Definition\Builder\VariableNodeDefinition

Indirect known subclasses

Symfony\Component\Config\Definition\Builder\BooleanNodeDefinition, Symfony\Component\Config\Definition\Builder\EnumNodeDefinition, Symfony\Component\Config\Definition\Builder\FloatNodeDefinition, Symfony\Component\Config\Definition\Builder\IntegerNodeDefinition, Symfony\Component\Config\Definition\Builder\NumericNodeDefinition, Symfony\Component\Config\Definition\Builder\ScalarNodeDefinition

Abstract
Namespace: Symfony\Component\Config\Definition\Builder
Author: Johannes M. Schmitt <schmittjoh@gmail.com>
Located at config/Symfony/Component/Config/Definition/Builder/NodeDefinition.php

Properties summary
`protected mixed`	`$name`		#
`protected mixed`	`$normalization`		#
`protected mixed`	`$validation`		#
`protected mixed`	`$defaultValue`		#
`protected mixed`	`$default`		#
`protected mixed`	`$required`		#
`protected mixed`	`$merge`		#
`protected mixed`	`$allowEmptyValue`		#
`protected mixed`	`$nullEquivalent`		#
`protected mixed`	`$trueEquivalent`		#
`protected mixed`	`$falseEquivalent`		#
`protected Symfony\Component\Config\Definition\Builder\NodeParentInterface\|Symfony\Component\Config\Definition\NodeInterface`	`$parent`		#
`protected array`	`$attributes`	`array()`	#

Namespaces

Classes

Interfaces

Class NodeDefinition

Direct known subclasses

Indirect known subclasses

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Throws

`public`	# `__construct( string $name, Symfony\Component\Config\Definition\Builder\NodeParentInterface $parent = null )` Constructor Constructor Parameters `$name` `string` $name The name of the node `$parent` `Symfony\Component\Config\Definition\Builder\NodeParentInterface` $parent The parent
`public Symfony\Component\Config\Definition\Builder\NodeDefinition`	# `setParent( Symfony\Component\Config\Definition\Builder\NodeParentInterface $parent )` Sets the parent node. Sets the parent node. Parameters `$parent` `Symfony\Component\Config\Definition\Builder\NodeParentInterface` $parent The parent Returns `Symfony\Component\Config\Definition\Builder\NodeDefinition`
`public Symfony\Component\Config\Definition\Builder\NodeDefinition`	# `info( string $info )` Sets info message. Sets info message. Parameters `$info` `string` $info The info text Returns `Symfony\Component\Config\Definition\Builder\NodeDefinition`
`public Symfony\Component\Config\Definition\Builder\NodeDefinition`	# `example( string\|array $example )` Sets example configuration. Sets example configuration. Parameters `$example` `string\|array` $example Returns `Symfony\Component\Config\Definition\Builder\NodeDefinition`
`public Symfony\Component\Config\Definition\Builder\NodeDefinition`	# `attribute( string $key, mixed $value )` Sets an attribute on the node. Sets an attribute on the node. Parameters `$key` `string` $key `$value` `mixed` $value Returns `Symfony\Component\Config\Definition\Builder\NodeDefinition`
`public Symfony\Component\Config\Definition\Builder\NodeParentInterface`	# `end( )` Returns the parent node. Returns the parent node. Returns `Symfony\Component\Config\Definition\Builder\NodeParentInterface` The builder of the parent node
`public Symfony\Component\Config\Definition\NodeInterface`	# `getNode( Boolean $forceRootNode = false )` Creates the node. Creates the node. Parameters `$forceRootNode` `Boolean` $forceRootNode Whether to force this node as the root node Returns `Symfony\Component\Config\Definition\NodeInterface`
`public Symfony\Component\Config\Definition\Builder\NodeDefinition`	# `defaultValue( mixed $value )` Sets the default value. Sets the default value. Parameters `$value` `mixed` $value The default value Returns `Symfony\Component\Config\Definition\Builder\NodeDefinition`
`public Symfony\Component\Config\Definition\Builder\NodeDefinition`	# `isRequired( )` Sets the node as required. Sets the node as required. Returns `Symfony\Component\Config\Definition\Builder\NodeDefinition`
`public Symfony\Component\Config\Definition\Builder\NodeDefinition`	# `treatNullLike( mixed $value )` Sets the equivalent value used when the node contains null. Sets the equivalent value used when the node contains null. Parameters `$value` `mixed` $value Returns `Symfony\Component\Config\Definition\Builder\NodeDefinition`
`public Symfony\Component\Config\Definition\Builder\NodeDefinition`	# `treatTrueLike( mixed $value )` Sets the equivalent value used when the node contains true. Sets the equivalent value used when the node contains true. Parameters `$value` `mixed` $value Returns `Symfony\Component\Config\Definition\Builder\NodeDefinition`
`public Symfony\Component\Config\Definition\Builder\NodeDefinition`	# `treatFalseLike( mixed $value )` Sets the equivalent value used when the node contains false. Sets the equivalent value used when the node contains false. Parameters `$value` `mixed` $value Returns `Symfony\Component\Config\Definition\Builder\NodeDefinition`
`public Symfony\Component\Config\Definition\Builder\NodeDefinition`	# `defaultNull( )` Sets null as the default value. Sets null as the default value. Returns `Symfony\Component\Config\Definition\Builder\NodeDefinition`
`public Symfony\Component\Config\Definition\Builder\NodeDefinition`	# `defaultTrue( )` Sets true as the default value. Sets true as the default value. Returns `Symfony\Component\Config\Definition\Builder\NodeDefinition`
`public Symfony\Component\Config\Definition\Builder\NodeDefinition`	# `defaultFalse( )` Sets false as the default value. Sets false as the default value. Returns `Symfony\Component\Config\Definition\Builder\NodeDefinition`
`public Symfony\Component\Config\Definition\Builder\ExprBuilder`	# `beforeNormalization( )` Sets an expression to run before the normalization. Sets an expression to run before the normalization. Returns `Symfony\Component\Config\Definition\Builder\ExprBuilder`
`public Symfony\Component\Config\Definition\Builder\NodeDefinition`	# `cannotBeEmpty( )` Denies the node value being empty. Denies the node value being empty. Returns `Symfony\Component\Config\Definition\Builder\NodeDefinition`
`public Symfony\Component\Config\Definition\Builder\ExprBuilder`	# `validate( )` Sets an expression to run for the validation. 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. Returns `Symfony\Component\Config\Definition\Builder\ExprBuilder`
`public Symfony\Component\Config\Definition\Builder\NodeDefinition`	# `cannotBeOverwritten( Boolean $deny = true )` Sets whether the node can be overwritten. Sets whether the node can be overwritten. Parameters `$deny` `Boolean` $deny Whether the overwriting is forbidden or not Returns `Symfony\Component\Config\Definition\Builder\NodeDefinition`
`protected Symfony\Component\Config\Definition\Builder\ValidationBuilder`	# `validation( )` Gets the builder for validation rules. Gets the builder for validation rules. Returns `Symfony\Component\Config\Definition\Builder\ValidationBuilder`
`protected Symfony\Component\Config\Definition\Builder\MergeBuilder`	# `merge( )` Gets the builder for merging rules. Gets the builder for merging rules. Returns `Symfony\Component\Config\Definition\Builder\MergeBuilder`
`protected Symfony\Component\Config\Definition\Builder\NormalizationBuilder`	# `normalization( )` Gets the builder for normalization rules. Gets the builder for normalization rules. Returns `Symfony\Component\Config\Definition\Builder\NormalizationBuilder`
`abstract protected Symfony\Component\Config\Definition\NodeInterface`	# `createNode( )` Instantiate and configure the node according to this definition Instantiate and configure the node according to this definition Returns `Symfony\Component\Config\Definition\NodeInterface` $node The node instance Throws `Symfony\Component\Config\Definition\Exception\InvalidDefinitionException` When the definition is invalid