NodeDefinition
class NodeDefinition implements NodeParentInterface
This class provides a fluent interface for defining a node.
Methods
Sets info message.
Sets example configuration.
Sets an attribute on the node.
Returns the parent node.
Creates the node.
Sets the default value.
Sets the node as required.
Sets the equivalent value used when the node contains null.
Sets the equivalent value used when the node contains true.
Sets the equivalent value used when the node contains false.
Sets null as the default value.
Sets true as the default value.
Sets false as the default value.
Sets an expression to run before the normalization.
Denies the node value being empty.
Sets an expression to run for the validation.
Sets whether the node can be overwritten.
Details
at line line 48
__construct(string $name, NodeParentInterface $parent = null)
Constructor.
at line line 61
NodeDefinition|$this
setParent(NodeParentInterface $parent)
Sets the parent node.
at line line 75
NodeDefinition|$this
info(string $info)
Sets info message.
at line line 87
NodeDefinition|$this
example(string|array $example)
Sets example configuration.
at line line 100
NodeDefinition|$this
attribute(string $key, mixed $value)
Sets an attribute on the node.
at line line 112
NodeParentInterface|null
end()
Returns the parent node.
at line line 124
NodeInterface
getNode(bool $forceRootNode = false)
Creates the node.
at line line 151
NodeDefinition|$this
defaultValue(mixed $value)
Sets the default value.
at line line 164
NodeDefinition|$this
isRequired()
Sets the node as required.
at line line 178
NodeDefinition|$this
treatNullLike(mixed $value)
Sets the equivalent value used when the node contains null.
at line line 192
NodeDefinition|$this
treatTrueLike(mixed $value)
Sets the equivalent value used when the node contains true.
at line line 206
NodeDefinition|$this
treatFalseLike(mixed $value)
Sets the equivalent value used when the node contains false.
at line line 218
NodeDefinition|$this
defaultNull()
Sets null as the default value.
at line line 228
NodeDefinition|$this
defaultTrue()
Sets true as the default value.
at line line 238
NodeDefinition|$this
defaultFalse()
Sets false as the default value.
at line line 248
ExprBuilder
beforeNormalization()
Sets an expression to run before the normalization.
at line line 258
NodeDefinition|$this
cannotBeEmpty()
Denies the node value being empty.
at line line 274
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.
at line line 286
NodeDefinition|$this
cannotBeOverwritten(bool $deny = true)
Sets whether the node can be overwritten.