Symfony2 API
Class

Symfony\Component\Config\Definition\Builder\VariableNodeDefinition

class VariableNodeDefinition extends NodeDefinition

This class provides a fluent interface for defining a node.

Methods

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

Constructor

 from NodeDefinition
NodeDefinition setParent(NodeParentInterface $parent)

Sets the parent node.

 from NodeDefinition
NodeDefinition info(string $info)

Sets info message.

 from NodeDefinition
NodeDefinition example(string|array $example)

Sets example configuration.

 from NodeDefinition
NodeDefinition attribute(string $key, mixed $value)

Sets an attribute on the node.

 from NodeDefinition
NodeParentInterface end()

Returns the parent node.

 from NodeDefinition
NodeInterface getNode(Boolean $forceRootNode = false)

Creates the node.

 from NodeDefinition
NodeDefinition defaultValue(mixed $value)

Sets the default value.

 from NodeDefinition
NodeDefinition isRequired()

Sets the node as required.

 from NodeDefinition
NodeDefinition treatNullLike(mixed $value)

Sets the equivalent value used when the node contains null.

 from NodeDefinition
NodeDefinition treatTrueLike(mixed $value)

Sets the equivalent value used when the node contains true.

 from NodeDefinition
NodeDefinition treatFalseLike(mixed $value)

Sets the equivalent value used when the node contains false.

 from NodeDefinition
NodeDefinition defaultNull()

Sets null as the default value.

 from NodeDefinition
NodeDefinition defaultTrue()

Sets true as the default value.

 from NodeDefinition
NodeDefinition defaultFalse()

Sets false as the default value.

 from NodeDefinition
ExprBuilder beforeNormalization()

Sets an expression to run before the normalization.

 from NodeDefinition
NodeDefinition cannotBeEmpty()

Denies the node value being empty.

 from NodeDefinition
ExprBuilder validate()

Sets an expression to run for the validation.

 from NodeDefinition
NodeDefinition cannotBeOverwritten(Boolean $deny = true)

Sets whether the node can be overwritten.

 from NodeDefinition

Details

in NodeDefinition at line 47
public __construct(string $name, NodeParentInterface $parent = null)

Constructor

Parameters

string $name The name of the node
NodeParentInterface $parent The parent

in NodeDefinition at line 64
public NodeDefinition setParent(NodeParentInterface $parent)

Sets the parent node.

Parameters

NodeParentInterface $parent The parent

Return Value

NodeDefinition

in NodeDefinition at line 78
public NodeDefinition info(string $info)

Sets info message.

Parameters

string $info The info text

Return Value

NodeDefinition

in NodeDefinition at line 90
public NodeDefinition example(string|array $example)

Sets example configuration.

Parameters

string|array $example

Return Value

NodeDefinition

in NodeDefinition at line 103
public NodeDefinition attribute(string $key, mixed $value)

Sets an attribute on the node.

Parameters

string $key
mixed $value

Return Value

NodeDefinition

in NodeDefinition at line 115
public NodeParentInterface end()

Returns the parent node.

Return Value

NodeParentInterface The builder of the parent node

in NodeDefinition at line 127
public NodeInterface getNode(Boolean $forceRootNode = false)

Creates the node.

Parameters

Boolean $forceRootNode Whether to force this node as the root node

Return Value

NodeInterface

in NodeDefinition at line 154
public NodeDefinition defaultValue(mixed $value)

Sets the default value.

Parameters

mixed $value The default value

Return Value

NodeDefinition

in NodeDefinition at line 167
public NodeDefinition isRequired()

Sets the node as required.

Return Value

NodeDefinition

in NodeDefinition at line 181
public NodeDefinition treatNullLike(mixed $value)

Sets the equivalent value used when the node contains null.

Parameters

mixed $value

Return Value

NodeDefinition

in NodeDefinition at line 195
public NodeDefinition treatTrueLike(mixed $value)

Sets the equivalent value used when the node contains true.

Parameters

mixed $value

Return Value

NodeDefinition

in NodeDefinition at line 209
public NodeDefinition treatFalseLike(mixed $value)

Sets the equivalent value used when the node contains false.

Parameters

mixed $value

Return Value

NodeDefinition

in NodeDefinition at line 221
public NodeDefinition defaultNull()

Sets null as the default value.

Return Value

NodeDefinition

in NodeDefinition at line 231
public NodeDefinition defaultTrue()

Sets true as the default value.

Return Value

NodeDefinition

in NodeDefinition at line 241
public NodeDefinition defaultFalse()

Sets false as the default value.

Return Value

NodeDefinition

in NodeDefinition at line 251
public ExprBuilder beforeNormalization()

Sets an expression to run before the normalization.

Return Value

ExprBuilder

in NodeDefinition at line 261
public NodeDefinition cannotBeEmpty()

Denies the node value being empty.

Return Value

NodeDefinition

in NodeDefinition at line 277
public ExprBuilder validate()

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.

Return Value

ExprBuilder

in NodeDefinition at line 289
public NodeDefinition cannotBeOverwritten(Boolean $deny = true)

Sets whether the node can be overwritten.

Parameters

Boolean $deny Whether the overwriting is forbidden or not

Return Value

NodeDefinition