Definition\ScalarNode (Component\Config)
Symfony\Component\Config\Definition\ScalarNode
class ScalarNode extends VariableNode
This node represents a scalar value in the config tree.
The following values are considered scalars: * booleans * strings * null * integers * floats
Methods
__construct(string $name, NodeInterface $parent = null) Constructor. | from BaseNode | |
setAttribute($key, $value) | from BaseNode | |
getAttribute($key, $default = null) | from BaseNode | |
hasAttribute($key) | from BaseNode | |
getAttributes() | from BaseNode | |
setAttributes(array $attributes) | from BaseNode | |
removeAttribute($key) | from BaseNode | |
setInfo(string $info) Sets an info message. | from BaseNode | |
string | getInfo() Returns info message. | from BaseNode |
setExample(string|array $example) Sets the example configuration for this node. | from BaseNode | |
string|array | getExample() Retrieves the example configuration for this node. | from BaseNode |
addEquivalentValue(mixed $originalValue, mixed $equivalentValue) Adds an equivalent value. | from BaseNode | |
setRequired(bool $boolean) Set this node as required. | from BaseNode | |
setAllowOverwrite(bool $allow) Sets if this node can be overridden. | from BaseNode | |
setNormalizationClosures(array $closures) Sets the closures used for normalization. | from BaseNode | |
setFinalValidationClosures(array $closures) Sets the closures used for final validation. | from BaseNode | |
bool | isRequired() Checks if this node is required. | from BaseNode |
string | getName() Returns the name of this node. | from BaseNode |
string | getPath() Retrieves the path of this node. | from BaseNode |
mixed | merge(mixed $leftSide, mixed $rightSide) Merges two values together. | from BaseNode |
mixed | normalize(mixed $value) Normalizes a value, applying all normalization closures. | from BaseNode |
NodeInterface|null | getParent() Returns parent node for this node. | from BaseNode |
mixed | finalize(mixed $value) Finalizes a value, applying all finalization closures. | from BaseNode |
setDefaultValue($value) {@inheritdoc} | from VariableNode | |
bool | hasDefaultValue() Returns true when the node has a default value. | from VariableNode |
mixed | getDefaultValue() Returns the default value of the node. | from VariableNode |
setAllowEmptyValue(bool $boolean) Sets if this node is allowed to have an empty value. | from VariableNode | |
setName(string $name) Sets the name of the node. | from VariableNode |
Details
public __construct(string $name, NodeInterface $parent = null)
Constructor.
public setAttribute($key, $value)
public getAttribute($key, $default = null)
public hasAttribute($key)
public getAttributes()
public setAttributes(array $attributes)
public removeAttribute($key)
public setInfo(string $info)
Sets an info message.
public string getInfo()
Returns info message.
public setExample(string|array $example)
Sets the example configuration for this node.
public string|array getExample()
Retrieves the example configuration for this node.
public addEquivalentValue(mixed $originalValue, mixed $equivalentValue)
Adds an equivalent value.
public setRequired(bool $boolean)
Set this node as required.
public setAllowOverwrite(bool $allow)
Sets if this node can be overridden.
public setNormalizationClosures(array $closures)
Sets the closures used for normalization.
public setFinalValidationClosures(array $closures)
Sets the closures used for final validation.
public bool isRequired()
Checks if this node is required.
public string getName()
Returns the name of this node.
public string getPath()
Retrieves the path of this node.
final public mixed merge(mixed $leftSide, mixed $rightSide)
Merges two values together.
final public mixed normalize(mixed $value)
Normalizes a value, applying all normalization closures.
public NodeInterface|null getParent()
Returns parent node for this node.
final public mixed finalize(mixed $value)
Finalizes a value, applying all finalization closures.
public setDefaultValue($value)
{@inheritdoc}
public bool hasDefaultValue()
Returns true when the node has a default value.
public mixed getDefaultValue()
Returns the default value of the node.
public setAllowEmptyValue(bool $boolean)
Sets if this node is allowed to have an empty value.
public setName(string $name)
Sets the name of the node.
© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Config/Definition/ScalarNode.html