Definition\Builder\VariableNodeDefinition (Component\Config)
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|$this | setParent(NodeParentInterface $parent) Sets the parent node. | from NodeDefinition |
NodeDefinition|$this | info(string $info) Sets info message. | from NodeDefinition |
NodeDefinition|$this | example(string|array $example) Sets example configuration. | from NodeDefinition |
NodeDefinition|$this | attribute(string $key, mixed $value) Sets an attribute on the node. | from NodeDefinition |
NodeParentInterface|null | end() Returns the parent node. | from NodeDefinition |
NodeInterface | getNode(bool $forceRootNode = false) Creates the node. | from NodeDefinition |
NodeDefinition|$this | defaultValue(mixed $value) Sets the default value. | from NodeDefinition |
NodeDefinition|$this | isRequired() Sets the node as required. | from NodeDefinition |
NodeDefinition|$this | treatNullLike(mixed $value) Sets the equivalent value used when the node contains null. | from NodeDefinition |
NodeDefinition|$this | treatTrueLike(mixed $value) Sets the equivalent value used when the node contains true. | from NodeDefinition |
NodeDefinition|$this | treatFalseLike(mixed $value) Sets the equivalent value used when the node contains false. | from NodeDefinition |
NodeDefinition|$this | defaultNull() Sets null as the default value. | from NodeDefinition |
NodeDefinition|$this | defaultTrue() Sets true as the default value. | from NodeDefinition |
NodeDefinition|$this | defaultFalse() Sets false as the default value. | from NodeDefinition |
ExprBuilder | beforeNormalization() Sets an expression to run before the normalization. | from NodeDefinition |
NodeDefinition|$this | cannotBeEmpty() Denies the node value being empty. | from NodeDefinition |
ExprBuilder | validate() Sets an expression to run for the validation. | from NodeDefinition |
NodeDefinition|$this | cannotBeOverwritten(bool $deny = true) Sets whether the node can be overwritten. | from NodeDefinition |
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.
© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Config/Definition/Builder/VariableNodeDefinition.html