ScalarNodeDefinition
extends VariableNodeDefinition
in package
This class provides a fluent interface for defining a node.
Tags
Table of Contents
- $allowEmptyValue : mixed
- $attributes : mixed
- $default : mixed
- $defaultValue : mixed
- $deprecationMessage : mixed
- $falseEquivalent : mixed
- $merge : mixed
- $name : mixed
- $normalization : mixed
- $nullEquivalent : mixed
- $parent : mixed
- $pathSeparator : mixed
- $required : mixed
- $trueEquivalent : mixed
- $validation : mixed
- __construct() : mixed
- attribute() : $this
- Sets an attribute on the node.
- beforeNormalization() : ExprBuilder
- Sets an expression to run before the normalization.
- cannotBeEmpty() : $this
- Denies the node value being empty.
- cannotBeOverwritten() : $this
- Sets whether the node can be overwritten.
- defaultFalse() : $this
- Sets false as the default value.
- defaultNull() : $this
- Sets null as the default value.
- defaultTrue() : $this
- Sets true as the default value.
- defaultValue() : $this
- Sets the default value.
- end() : NodeParentInterface|NodeBuilder|NodeDefinition|ArrayNodeDefinition|VariableNodeDefinition|null
- Returns the parent node.
- example() : $this
- Sets example configuration.
- getNode() : NodeInterface
- Creates the node.
- info() : $this
- Sets info message.
- isRequired() : $this
- Sets the node as required.
- setDeprecated() : $this
- Sets the node as deprecated.
- setParent() : $this
- Sets the parent node.
- setPathSeparator() : $this
- Set PathSeparator to use.
- treatFalseLike() : $this
- Sets the equivalent value used when the node contains false.
- treatNullLike() : $this
- Sets the equivalent value used when the node contains null.
- treatTrueLike() : $this
- Sets the equivalent value used when the node contains true.
- validate() : ExprBuilder
- Sets an expression to run for the validation.
- createNode() : NodeInterface
- Instantiate and configure the node according to this definition.
- instantiateNode() : ScalarNode
- Instantiate a Node.
- merge() : MergeBuilder
- Gets the builder for merging rules.
- normalization() : NormalizationBuilder
- Gets the builder for normalization rules.
- validation() : ValidationBuilder
- Gets the builder for validation rules.
Properties
$allowEmptyValue
protected
mixed
$allowEmptyValue
= true
$attributes
protected
mixed
$attributes
= []
$default
protected
mixed
$default
= false
$defaultValue
protected
mixed
$defaultValue
$deprecationMessage
protected
mixed
$deprecationMessage
= null
$falseEquivalent
protected
mixed
$falseEquivalent
= false
$merge
protected
mixed
$merge
$name
protected
mixed
$name
$normalization
protected
mixed
$normalization
$nullEquivalent
protected
mixed
$nullEquivalent
$parent
protected
mixed
$parent
$pathSeparator
protected
mixed
$pathSeparator
= \Symfony\Component\Config\Definition\BaseNode::DEFAULT_PATH_SEPARATOR
$required
protected
mixed
$required
= false
$trueEquivalent
protected
mixed
$trueEquivalent
= true
$validation
protected
mixed
$validation
Methods
__construct()
public
__construct(string|null $name[, NodeParentInterface $parent = null ]) : mixed
Parameters
- $name : string|null
- $parent : NodeParentInterface = null
Return values
mixed —attribute()
Sets an attribute on the node.
public
attribute(string $key, mixed $value) : $this
Parameters
- $key : string
- $value : mixed
Return values
$this —beforeNormalization()
Sets an expression to run before the normalization.
public
beforeNormalization() : ExprBuilder
Return values
ExprBuilder —cannotBeEmpty()
Denies the node value being empty.
public
cannotBeEmpty() : $this
Return values
$this —cannotBeOverwritten()
Sets whether the node can be overwritten.
public
cannotBeOverwritten([bool $deny = true ]) : $this
Parameters
- $deny : bool = true
Return values
$this —defaultFalse()
Sets false as the default value.
public
defaultFalse() : $this
Return values
$this —defaultNull()
Sets null as the default value.
public
defaultNull() : $this
Return values
$this —defaultTrue()
Sets true as the default value.
public
defaultTrue() : $this
Return values
$this —defaultValue()
Sets the default value.
public
defaultValue(mixed $value) : $this
Parameters
- $value : mixed
-
The default value
Return values
$this —end()
Returns the parent node.
public
end() : NodeParentInterface|NodeBuilder|NodeDefinition|ArrayNodeDefinition|VariableNodeDefinition|null
Return values
NodeParentInterface|NodeBuilder|NodeDefinition|ArrayNodeDefinition|VariableNodeDefinition|null —The builder of the parent node
example()
Sets example configuration.
public
example(string|array<string|int, mixed> $example) : $this
Parameters
- $example : string|array<string|int, mixed>
Return values
$this —getNode()
Creates the node.
public
getNode([bool $forceRootNode = false ]) : NodeInterface
Parameters
- $forceRootNode : bool = false
-
Whether to force this node as the root node
Return values
NodeInterface —info()
Sets info message.
public
info(string $info) : $this
Parameters
- $info : string
Return values
$this —isRequired()
Sets the node as required.
public
isRequired() : $this
Return values
$this —setDeprecated()
Sets the node as deprecated.
public
setDeprecated([string $message = 'The child node "%node%" at path "%path%" is deprecated.' ]) : $this
You can use %node% and %path% placeholders in your message to display, respectively, the node name and its complete path.
Parameters
- $message : string = 'The child node "%node%" at path "%path%" is deprecated.'
Return values
$this —setParent()
Sets the parent node.
public
setParent(NodeParentInterface $parent) : $this
Parameters
- $parent : NodeParentInterface
Return values
$this —setPathSeparator()
Set PathSeparator to use.
public
setPathSeparator(string $separator) : $this
Parameters
- $separator : string
Return values
$this —treatFalseLike()
Sets the equivalent value used when the node contains false.
public
treatFalseLike(mixed $value) : $this
Parameters
- $value : mixed
Return values
$this —treatNullLike()
Sets the equivalent value used when the node contains null.
public
treatNullLike(mixed $value) : $this
Parameters
- $value : mixed
Return values
$this —treatTrueLike()
Sets the equivalent value used when the node contains true.
public
treatTrueLike(mixed $value) : $this
Parameters
- $value : mixed
Return values
$this —validate()
Sets an expression to run for the validation.
public
validate() : ExprBuilder
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 values
ExprBuilder —createNode()
Instantiate and configure the node according to this definition.
protected
abstract createNode() : NodeInterface
Tags
Return values
NodeInterface —The node instance
instantiateNode()
Instantiate a Node.
protected
instantiateNode() : ScalarNode
Return values
ScalarNode —The node
merge()
Gets the builder for merging rules.
protected
merge() : MergeBuilder
Return values
MergeBuilder —normalization()
Gets the builder for normalization rules.
protected
normalization() : NormalizationBuilder
Return values
NormalizationBuilder —validation()
Gets the builder for validation rules.
protected
validation() : ValidationBuilder