Symfony2 API
Class

Symfony\Component\Config\Definition\Builder\NodeDefinition

abstract class NodeDefinition implements NodeParentInterface

This class provides a fluent interface for defining a node.

Methods

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

Constructor.

NodeDefinition|$this setParent(NodeParentInterface $parent)

Sets the parent node.

NodeDefinition|$this info(string $info)

Sets info message.

NodeDefinition|$this example(string|array $example)

Sets example configuration.

NodeDefinition|$this attribute(string $key, mixed $value)

Sets an attribute on the node.

NodeParentInterface|null end()

Returns the parent node.

NodeInterface getNode(bool $forceRootNode = false)

Creates the node.

NodeDefinition|$this defaultValue(mixed $value)

Sets the default value.

NodeDefinition|$this isRequired()

Sets the node as required.

NodeDefinition|$this treatNullLike(mixed $value)

Sets the equivalent value used when the node contains null.

NodeDefinition|$this treatTrueLike(mixed $value)

Sets the equivalent value used when the node contains true.

NodeDefinition|$this treatFalseLike(mixed $value)

Sets the equivalent value used when the node contains false.

NodeDefinition|$this defaultNull()

Sets null as the default value.

NodeDefinition|$this defaultTrue()

Sets true as the default value.

NodeDefinition|$this defaultFalse()

Sets false as the default value.

ExprBuilder beforeNormalization()

Sets an expression to run before the normalization.

NodeDefinition|$this cannotBeEmpty()

Denies the node value being empty.

ExprBuilder validate()

Sets an expression to run for the validation.

NodeDefinition|$this cannotBeOverwritten(bool $deny = true)

Sets whether the node can be overwritten.

Details

at line 48
public __construct(string $name, NodeParentInterface $parent = null)

Constructor.

Parameters

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

at line 61
public NodeDefinition|$this setParent(NodeParentInterface $parent)

Sets the parent node.

Parameters

NodeParentInterface $parent The parent

Return Value

NodeDefinition|$this

at line 75
public NodeDefinition|$this info(string $info)

Sets info message.

Parameters

string $info The info text

Return Value

NodeDefinition|$this

at line 87
public NodeDefinition|$this example(string|array $example)

Sets example configuration.

Parameters

string|array $example

Return Value

NodeDefinition|$this

at line 100
public NodeDefinition|$this attribute(string $key, mixed $value)

Sets an attribute on the node.

Parameters

string $key
mixed $value

Return Value

NodeDefinition|$this

at line 112
public NodeParentInterface|null end()

Returns the parent node.

Return Value

NodeParentInterface|null The builder of the parent node

at line 124
public NodeInterface getNode(bool $forceRootNode = false)

Creates the node.

Parameters

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

Return Value

NodeInterface

at line 151
public NodeDefinition|$this defaultValue(mixed $value)

Sets the default value.

Parameters

mixed $value The default value

Return Value

NodeDefinition|$this

at line 164
public NodeDefinition|$this isRequired()

Sets the node as required.

Return Value

NodeDefinition|$this

at line 178
public NodeDefinition|$this treatNullLike(mixed $value)

Sets the equivalent value used when the node contains null.

Parameters

mixed $value

Return Value

NodeDefinition|$this

at line 192
public NodeDefinition|$this treatTrueLike(mixed $value)

Sets the equivalent value used when the node contains true.

Parameters

mixed $value

Return Value

NodeDefinition|$this

at line 206
public NodeDefinition|$this treatFalseLike(mixed $value)

Sets the equivalent value used when the node contains false.

Parameters

mixed $value

Return Value

NodeDefinition|$this

at line 218
public NodeDefinition|$this defaultNull()

Sets null as the default value.

Return Value

NodeDefinition|$this

at line 228
public NodeDefinition|$this defaultTrue()

Sets true as the default value.

Return Value

NodeDefinition|$this

at line 238
public NodeDefinition|$this defaultFalse()

Sets false as the default value.

Return Value

NodeDefinition|$this

at line 248
public ExprBuilder beforeNormalization()

Sets an expression to run before the normalization.

Return Value

ExprBuilder

at line 258
public NodeDefinition|$this cannotBeEmpty()

Denies the node value being empty.

Return Value

NodeDefinition|$this

at line 274
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

at line 286
public NodeDefinition|$this cannotBeOverwritten(bool $deny = true)

Sets whether the node can be overwritten.

Parameters

bool $deny Whether the overwriting is forbidden or not

Return Value

NodeDefinition|$this