Symfony\Component\Config\Definition\Builder\NodeDefinition

abstract class NodeDefinition implements NodeParentInterface

Methods

	__construct(string $name, NodeParentInterface $parent = null) Constructor
NodeDefinition	setParent(NodeParentInterface $parent) Sets the parent node.
NodeDefinition	info(string $info) Sets info message.
NodeDefinition	example(string|array $example) Sets example configuration.
NodeDefinition	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	defaultValue(mixed $value) Sets the default value.
NodeDefinition	isRequired() Sets the node as required.
NodeDefinition	treatNullLike(mixed $value) Sets the equivalent value used when the node contains null.
NodeDefinition	treatTrueLike(mixed $value) Sets the equivalent value used when the node contains true.
NodeDefinition	treatFalseLike(mixed $value) Sets the equivalent value used when the node contains false.
NodeDefinition	defaultNull() Sets null as the default value.
NodeDefinition	defaultTrue() Sets true as the default value.
NodeDefinition	defaultFalse() Sets false as the default value.
ExprBuilder	beforeNormalization() Sets an expression to run before the normalization.
NodeDefinition	cannotBeEmpty() Denies the node value being empty.
ExprBuilder	validate() Sets an expression to run for the validation.
NodeDefinition	cannotBeOverwritten(bool $deny = true) Sets whether the node can be overwritten.

Details

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

Constructor

public NodeDefinition setParent(NodeParentInterface $parent)

Sets the parent node.

public NodeDefinition info(string $info)

Sets info message.

public NodeDefinition example(string|array $example)

Sets example configuration.

public NodeDefinition 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 defaultValue(mixed $value)

Sets the default value.

public NodeDefinition isRequired()

Sets the node as required.

public NodeDefinition treatNullLike(mixed $value)

Sets the equivalent value used when the node contains null.

public NodeDefinition treatTrueLike(mixed $value)

Sets the equivalent value used when the node contains true.

public NodeDefinition treatFalseLike(mixed $value)

Sets the equivalent value used when the node contains false.

public NodeDefinition defaultNull()

Sets null as the default value.

public NodeDefinition defaultTrue()

Sets true as the default value.

public NodeDefinition defaultFalse()

Sets false as the default value.

public ExprBuilder beforeNormalization()

Sets an expression to run before the normalization.

public NodeDefinition 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 cannotBeOverwritten(bool $deny = true)

Sets whether the node can be overwritten.