W3cubDocs

/Symfony 2.8

Symfony\Component\Config\Definition\BaseNode

abstract class BaseNode implements NodeInterface

The base node class.

Methods

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

Constructor.

setAttribute($key, $value)
getAttribute($key, $default = null)
hasAttribute($key)
getAttributes()
setAttributes(array $attributes)
removeAttribute($key)
setInfo(string $info)

Sets an info message.

string getInfo()

Returns info message.

setExample(string|array $example)

Sets the example configuration for this node.

string|array getExample()

Retrieves the example configuration for this node.

addEquivalentValue(mixed $originalValue, mixed $equivalentValue)

Adds an equivalent value.

setRequired(bool $boolean)

Set this node as required.

setAllowOverwrite(bool $allow)

Sets if this node can be overridden.

setNormalizationClosures(array $closures)

Sets the closures used for normalization.

setFinalValidationClosures(array $closures)

Sets the closures used for final validation.

bool isRequired()

Checks if this node is required.

string getName()

Returns the name of this node.

string getPath()

Retrieves the path of this node.

mixed merge(mixed $leftSide, mixed $rightSide)

Merges two values together.

mixed normalize(mixed $value)

Normalizes a value, applying all normalization closures.

NodeInterface|null getParent()

Returns parent node for this node.

mixed finalize(mixed $value)

Finalizes a value, applying all finalization closures.

Details

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

Constructor.

Parameters

string $name The name of the node
NodeInterface $parent The parent of this node

Exceptions

InvalidArgumentException if the name contains a period.

public setAttribute($key, $value)

Parameters

$key
$value

public getAttribute($key, $default = null)

Parameters

$key
$default

public hasAttribute($key)

Parameters

$key

public getAttributes()

public setAttributes(array $attributes)

Parameters

array $attributes

public removeAttribute($key)

Parameters

$key

public setInfo(string $info)

Sets an info message.

Parameters

string $info

public string getInfo()

Returns info message.

Return Value

string The info text

public setExample(string|array $example)

Sets the example configuration for this node.

Parameters

string|array $example

public string|array getExample()

Retrieves the example configuration for this node.

Return Value

string|array The example

public addEquivalentValue(mixed $originalValue, mixed $equivalentValue)

Adds an equivalent value.

Parameters

mixed $originalValue
mixed $equivalentValue

public setRequired(bool $boolean)

Set this node as required.

Parameters

bool $boolean Required node

public setAllowOverwrite(bool $allow)

Sets if this node can be overridden.

Parameters

bool $allow

public setNormalizationClosures(array $closures)

Sets the closures used for normalization.

Parameters

array $closures An array of Closures used for normalization

public setFinalValidationClosures(array $closures)

Sets the closures used for final validation.

Parameters

array $closures An array of Closures used for final validation

public bool isRequired()

Checks if this node is required.

Return Value

bool If the node is required

public string getName()

Returns the name of this node.

Return Value

string The Node's name.

public string getPath()

Retrieves the path of this node.

Return Value

string The Node's path

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

Merges two values together.

Parameters

mixed $leftSide
mixed $rightSide

Return Value

mixed The merged value

Exceptions

ForbiddenOverwriteException

final public mixed normalize(mixed $value)

Normalizes a value, applying all normalization closures.

Parameters

mixed $value Value to normalize.

Return Value

mixed The normalized value.

public NodeInterface|null getParent()

Returns parent node for this node.

Return Value

NodeInterface|null

final public mixed finalize(mixed $value)

Finalizes a value, applying all finalization closures.

Parameters

mixed $value The value to finalize

Return Value

mixed The finalized value

Exceptions

Exception
InvalidConfigurationException

© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/Config/Definition/BaseNode.html