Symfony\Component\Config\Definition\Builder\NodeDefinition

abstract class NodeDefinition implements NodeParentInterface

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

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

Constructor.

public NodeDefinition|$this setParent(NodeParentInterface $parent)

Sets the parent node.

public NodeDefinition|$this info(string $info)

Sets info message.

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

Sets example configuration.

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

Sets an attribute on the node.

public NodeParentInterface|null end()

Returns the parent node.

public NodeInterface getNode(bool $forceRootNode = false)

Creates the node.

public NodeDefinition|$this defaultValue(mixed $value)

Sets the default value.

public NodeDefinition|$this isRequired()

Sets the node as required.

public NodeDefinition|$this treatNullLike(mixed $value)

Sets the equivalent value used when the node contains null.

public NodeDefinition|$this treatTrueLike(mixed $value)

Sets the equivalent value used when the node contains true.

public NodeDefinition|$this treatFalseLike(mixed $value)

Sets the equivalent value used when the node contains false.

public NodeDefinition|$this defaultNull()

Sets null as the default value.

public NodeDefinition|$this defaultTrue()

Sets true as the default value.

public NodeDefinition|$this defaultFalse()

Sets false as the default value.

public ExprBuilder beforeNormalization()

Sets an expression to run before the normalization.

public NodeDefinition|$this cannotBeEmpty()

Denies the node value being empty.

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.

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

Sets whether the node can be overwritten.