Class BaseNode

The base node class

Symfony\Component\Config\Definition\BaseNode implements Symfony\Component\Config\Definition\NodeInterface

Direct known subclasses

Symfony\Component\Config\Definition\ArrayNode, Symfony\Component\Config\Definition\VariableNode

Indirect known subclasses

Symfony\Component\Config\Definition\BooleanNode, Symfony\Component\Config\Definition\EnumNode, Symfony\Component\Config\Definition\FloatNode, Symfony\Component\Config\Definition\IntegerNode, Symfony\Component\Config\Definition\NumericNode, Symfony\Component\Config\Definition\PrototypedArrayNode, Symfony\Component\Config\Definition\ScalarNode

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

Methods summary
`public`	# `__construct( string $name, Symfony\Component\Config\Definition\NodeInterface $parent = null )` Constructor. Constructor. Parameters `$name` `string` $name The name of the node `$parent` `Symfony\Component\Config\Definition\NodeInterface` $parent The parent of this node Throws `InvalidArgumentException` if the name contains a period.
`public`	# `setAttribute( mixed $key, mixed $value )`
`public`	# `getAttribute( mixed $key, mixed $default = null )`
`public`	# `hasAttribute( mixed $key )`
`public`	# `getAttributes( )`
`public`	# `setAttributes( array $attributes )`
`public`	# `removeAttribute( mixed $key )`
`public`	# `setInfo( string $info )` Sets an info message. Sets an info message. Parameters `$info` `string` $info
`public string`	# `getInfo( )` Returns info message. Returns info message. Returns `string` The info text
`public`	# `setExample( string\|array $example )` Sets the example configuration for this node. Sets the example configuration for this node. Parameters `$example` `string\|array` $example
`public string\|array`	# `getExample( )` Retrieves the example configuration for this node. Retrieves the example configuration for this node. Returns `string\|array` The example
`public`	# `addEquivalentValue( mixed $originalValue, mixed $equivalentValue )` Adds an equivalent value. Adds an equivalent value. Parameters `$originalValue` `mixed` $originalValue `$equivalentValue` `mixed` $equivalentValue
`public`	# `setRequired( Boolean $boolean )` Set this node as required. Set this node as required. Parameters `$boolean` `Boolean` $boolean Required node
`public`	# `setAllowOverwrite( Boolean $allow )` Sets if this node can be overridden. Sets if this node can be overridden. Parameters `$allow` `Boolean` $allow
`public`	# `setNormalizationClosures( array $closures )` Sets the closures used for normalization. Sets the closures used for normalization. Parameters `$closures` `Closure[]` $closures An array of Closures used for normalization
`public`	# `setFinalValidationClosures( array $closures )` Sets the closures used for final validation. Sets the closures used for final validation. Parameters `$closures` `Closure[]` $closures An array of Closures used for final validation
`public Boolean`	# `isRequired( )` Checks if this node is required. Checks if this node is required. Returns `Boolean` Implementation of `Symfony\Component\Config\Definition\NodeInterface::isRequired()`
`public string`	# `getName( )` Returns the name of this node Returns the name of this node Returns `string` The Node's name. Implementation of `Symfony\Component\Config\Definition\NodeInterface::getName()`
`public string`	# `getPath( )` Retrieves the path of this node. Retrieves the path of this node. Returns `string` The Node's path Implementation of `Symfony\Component\Config\Definition\NodeInterface::getPath()`
`final public mixed`	# `merge( mixed $leftSide, mixed $rightSide )` Merges two values together. Merges two values together. Parameters `$leftSide` `mixed` $leftSide `$rightSide` `mixed` $rightSide Returns `mixed` The merged value Throws `Symfony\Component\Config\Definition\Exception\ForbiddenOverwriteException` Implementation of `Symfony\Component\Config\Definition\NodeInterface::merge()`
`final public mixed`	# `normalize( mixed $value )` Normalizes a value, applying all normalization closures. Normalizes a value, applying all normalization closures. Parameters `$value` `mixed` $value Value to normalize. Returns `mixed` The normalized value. Implementation of `Symfony\Component\Config\Definition\NodeInterface::normalize()`
`protected mixed`	# `preNormalize( mixed $value )` Normalizes the value before any other normalization is applied. Normalizes the value before any other normalization is applied. Parameters `$value` `mixed` $value Returns `mixed` $value The normalized array value
`final public mixed`	# `finalize( mixed $value )` Finalizes a value, applying all finalization closures. Finalizes a value, applying all finalization closures. Parameters `$value` `mixed` $value The value to finalize Returns `mixed` The finalized value Throws `Symfony\Component\Config\Definition\Exception\InvalidConfigurationException` Implementation of `Symfony\Component\Config\Definition\NodeInterface::finalize()`
`abstract protected`	# `validateType( mixed $value )` Validates the type of a Node. Validates the type of a Node. Parameters `$value` `mixed` $value The value to validate Throws `InvalidTypeException` when the value is invalid
`abstract protected mixed`	# `normalizeValue( mixed $value )` Normalizes the value. Normalizes the value. Parameters `$value` `mixed` $value The value to normalize. Returns `mixed` The normalized value
`abstract protected mixed`	# `mergeValues( mixed $leftSide, mixed $rightSide )` Merges two values together. Merges two values together. Parameters `$leftSide` `mixed` $leftSide `$rightSide` `mixed` $rightSide Returns `mixed` The merged value
`abstract protected mixed`	# `finalizeValue( mixed $value )` Finalizes a value. Finalizes a value. Parameters `$value` `mixed` $value The value to finalize Returns `mixed` The finalized value

Methods inherited from Symfony\Component\Config\Definition\NodeInterface
`getDefaultValue(), hasDefaultValue()`

Properties summary
`protected mixed`	`$name`		#
`protected mixed`	`$parent`		#
`protected mixed`	`$normalizationClosures`		#
`protected mixed`	`$finalValidationClosures`		#
`protected mixed`	`$allowOverwrite`		#
`protected mixed`	`$required`		#
`protected mixed`	`$equivalentValues`		#
`protected array`	`$attributes`	`array()`	#

Namespaces

Classes

Interfaces

Class BaseNode

Direct known subclasses

Indirect known subclasses

Parameters

Throws

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Parameters

Returns

Throws

Implementation of

Parameters

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns