EnumNode
extends ScalarNode
in package
Node which only allows a finite set of values.
Tags
Table of Contents
- DEFAULT_PATH_SEPARATOR = '.'
- $allowEmptyValue : mixed
- $allowOverwrite : mixed
- $attributes : mixed
- $defaultValue : mixed
- $defaultValueSet : mixed
- $deprecation : mixed
- $equivalentValues : mixed
- $finalValidationClosures : mixed
- $name : mixed
- $normalizationClosures : mixed
- $parent : mixed
- $pathSeparator : mixed
- $required : mixed
- $handlingPlaceholder : mixed
- $placeholders : mixed
- $placeholderUniquePrefixes : mixed
- $values : mixed
- __construct() : mixed
- addEquivalentValue() : mixed
- Adds an equivalent value.
- finalize() : mixed
- Finalizes a value.
- getAttribute() : mixed
- getAttributes() : array<string|int, mixed>
- getDefaultValue() : mixed
- {@inheritdoc}
- getDeprecation() : array<string|int, mixed>
- getDeprecationMessage() : string
- Returns the deprecated message.
- getExample() : string|array<string|int, mixed>|null
- Retrieves the example configuration for this node.
- getInfo() : string|null
- Returns info message.
- getName() : string
- Returns the name of the node.
- getParent() : NodeInterface|null
- Returns parent node for this node.
- getPath() : string
- Returns the path of the node.
- getValues() : mixed
- hasAttribute() : bool
- hasDefaultValue() : mixed
- {@inheritdoc}
- isDeprecated() : bool
- Checks if this node is deprecated.
- isRequired() : bool
- Returns true when the node is required.
- merge() : mixed
- Merges two values together.
- normalize() : mixed
- Normalizes a value.
- removeAttribute() : mixed
- setAllowEmptyValue() : mixed
- Sets if this node is allowed to have an empty value.
- setAllowOverwrite() : mixed
- Sets if this node can be overridden.
- setAttribute() : mixed
- setAttributes() : mixed
- setDefaultValue() : mixed
- setDeprecated() : mixed
- Sets this node as deprecated.
- setExample() : mixed
- Sets the example configuration for this node.
- setFinalValidationClosures() : mixed
- Sets the closures used for final validation.
- setInfo() : mixed
- Sets an info message.
- setName() : mixed
- Sets the name of the node.
- setNormalizationClosures() : mixed
- Sets the closures used for normalization.
- setRequired() : mixed
- Set this node as required.
- allowPlaceholders() : bool
- {@inheritdoc}
- finalizeValue() : mixed
- {@inheritdoc}
- getValidPlaceholderTypes() : array<string|int, mixed>
- Gets allowed dynamic types for this node.
- isHandlingPlaceholder() : bool
- Tests if a placeholder is being handled currently.
- isValueEmpty() : bool
- Evaluates if the given value is to be treated as empty.
- mergeValues() : mixed
- Merges two values together.
- normalizeValue() : mixed
- Normalizes the value.
- preNormalize() : mixed
- Normalizes the value before any other normalization is applied.
- validateType() : mixed
- Validates the type of a Node.
- doValidateType() : void
- resolvePlaceholderValue() : mixed
Constants
DEFAULT_PATH_SEPARATOR
public
mixed
DEFAULT_PATH_SEPARATOR
= '.'
Properties
$allowEmptyValue
protected
mixed
$allowEmptyValue
= true
$allowOverwrite
protected
mixed
$allowOverwrite
= true
$attributes
protected
mixed
$attributes
= []
$defaultValue
protected
mixed
$defaultValue
$defaultValueSet
protected
mixed
$defaultValueSet
= false
$deprecation
protected
mixed
$deprecation
= []
$equivalentValues
protected
mixed
$equivalentValues
= []
$finalValidationClosures
protected
mixed
$finalValidationClosures
= []
$name
protected
mixed
$name
$normalizationClosures
protected
mixed
$normalizationClosures
= []
$parent
protected
mixed
$parent
$pathSeparator
protected
mixed
$pathSeparator
$required
protected
mixed
$required
= false
$handlingPlaceholder
private
mixed
$handlingPlaceholder
$placeholders
private
static mixed
$placeholders
= []
$placeholderUniquePrefixes
private
static mixed
$placeholderUniquePrefixes
= []
$values
private
mixed
$values
Methods
__construct()
public
__construct(string|null $name[, NodeInterface|null $parent = null ][, array<string|int, mixed> $values = [] ][, string $pathSeparator = BaseNode::DEFAULT_PATH_SEPARATOR ]) : mixed
Parameters
- $name : string|null
- $parent : NodeInterface|null = null
- $values : array<string|int, mixed> = []
- $pathSeparator : string = BaseNode::DEFAULT_PATH_SEPARATOR
Return values
mixed —addEquivalentValue()
Adds an equivalent value.
public
addEquivalentValue(mixed $originalValue, mixed $equivalentValue) : mixed
Parameters
- $originalValue : mixed
- $equivalentValue : mixed
Return values
mixed —finalize()
Finalizes a value.
public
final finalize(mixed $value) : mixed
Parameters
- $value : mixed
-
The value to finalize
Return values
mixed —getAttribute()
public
getAttribute(string $key[, mixed $default = null ]) : mixed
Parameters
- $key : string
- $default : mixed = null
Return values
mixed —getAttributes()
public
getAttributes() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDefaultValue()
{@inheritdoc}
public
getDefaultValue() : mixed
Return values
mixed —getDeprecation()
public
getDeprecation(string $node, string $path) : array<string|int, mixed>
Parameters
- $node : string
-
The configuration node name
- $path : string
-
The path of the node
Return values
array<string|int, mixed> —getDeprecationMessage()
Returns the deprecated message.
public
getDeprecationMessage(string $node, string $path) : string
Parameters
- $node : string
-
the configuration node name
- $path : string
-
the path of the node
Tags
Return values
string —getExample()
Retrieves the example configuration for this node.
public
getExample() : string|array<string|int, mixed>|null
Return values
string|array<string|int, mixed>|null —getInfo()
Returns info message.
public
getInfo() : string|null
Return values
string|null —getName()
Returns the name of the node.
public
getName() : string
Return values
string —getParent()
Returns parent node for this node.
public
getParent() : NodeInterface|null
Return values
NodeInterface|null —getPath()
Returns the path of the node.
public
getPath() : string
Return values
string —getValues()
public
getValues() : mixed
Return values
mixed —hasAttribute()
public
hasAttribute(string $key) : bool
Parameters
- $key : string
Return values
bool —hasDefaultValue()
{@inheritdoc}
public
hasDefaultValue() : mixed
Return values
mixed —isDeprecated()
Checks if this node is deprecated.
public
isDeprecated() : bool
Return values
bool —isRequired()
Returns true when the node is required.
public
isRequired() : bool
Return values
bool —merge()
Merges two values together.
public
final merge(mixed $leftSide, mixed $rightSide) : mixed
Parameters
- $leftSide : mixed
- $rightSide : mixed
Return values
mixed —normalize()
Normalizes a value.
public
final normalize(mixed $value) : mixed
Parameters
- $value : mixed
-
The value to normalize
Return values
mixed —removeAttribute()
public
removeAttribute(string $key) : mixed
Parameters
- $key : string
Return values
mixed —setAllowEmptyValue()
Sets if this node is allowed to have an empty value.
public
setAllowEmptyValue(bool $boolean) : mixed
Parameters
- $boolean : bool
-
True if this entity will accept empty values
Return values
mixed —setAllowOverwrite()
Sets if this node can be overridden.
public
setAllowOverwrite(bool $allow) : mixed
Parameters
- $allow : bool
Return values
mixed —setAttribute()
public
setAttribute(string $key, mixed $value) : mixed
Parameters
- $key : string
- $value : mixed
Return values
mixed —setAttributes()
public
setAttributes(array<string|int, mixed> $attributes) : mixed
Parameters
- $attributes : array<string|int, mixed>
Return values
mixed —setDefaultValue()
public
setDefaultValue(mixed $value) : mixed
Parameters
- $value : mixed
Return values
mixed —setDeprecated()
Sets this node as deprecated.
public
setDeprecated(string $package) : mixed
Parameters
- $package : string
-
The name of the composer package that is triggering the deprecation
Return values
mixed —setExample()
Sets the example configuration for this node.
public
setExample(string|array<string|int, mixed> $example) : mixed
Parameters
- $example : string|array<string|int, mixed>
Return values
mixed —setFinalValidationClosures()
Sets the closures used for final validation.
public
setFinalValidationClosures(array<string|int, Closure> $closures) : mixed
Parameters
- $closures : array<string|int, Closure>
-
An array of Closures used for final validation
Return values
mixed —setInfo()
Sets an info message.
public
setInfo(string $info) : mixed
Parameters
- $info : string
Return values
mixed —setName()
Sets the name of the node.
public
setName(string $name) : mixed
Parameters
- $name : string
Return values
mixed —setNormalizationClosures()
Sets the closures used for normalization.
public
setNormalizationClosures(array<string|int, Closure> $closures) : mixed
Parameters
- $closures : array<string|int, Closure>
-
An array of Closures used for normalization
Return values
mixed —setRequired()
Set this node as required.
public
setRequired(bool $boolean) : mixed
Parameters
- $boolean : bool
Return values
mixed —allowPlaceholders()
{@inheritdoc}
protected
allowPlaceholders() : bool
Return values
bool —finalizeValue()
{@inheritdoc}
protected
finalizeValue(mixed $value) : mixed
Parameters
- $value : mixed
Return values
mixed —getValidPlaceholderTypes()
Gets allowed dynamic types for this node.
protected
getValidPlaceholderTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —isHandlingPlaceholder()
Tests if a placeholder is being handled currently.
protected
isHandlingPlaceholder() : bool
Return values
bool —isValueEmpty()
Evaluates if the given value is to be treated as empty.
protected
isValueEmpty(mixed $value) : bool
By default, PHP's empty() function is used to test for emptiness. This method may be overridden by subtypes to better match their understanding of empty data.
Parameters
- $value : mixed
Tags
Return values
bool —mergeValues()
Merges two values together.
protected
abstract mergeValues(mixed $leftSide, mixed $rightSide) : mixed
Parameters
- $leftSide : mixed
- $rightSide : mixed
Return values
mixed —normalizeValue()
Normalizes the value.
protected
abstract normalizeValue(mixed $value) : mixed
Parameters
- $value : mixed
-
The value to normalize
Return values
mixed —preNormalize()
Normalizes the value before any other normalization is applied.
protected
preNormalize(mixed $value) : mixed
Parameters
- $value : mixed
Return values
mixed —validateType()
Validates the type of a Node.
protected
abstract validateType(mixed $value) : mixed
Parameters
- $value : mixed
-
The value to validate
Tags
Return values
mixed —doValidateType()
private
doValidateType(mixed $value) : void
Parameters
- $value : mixed
Return values
void —resolvePlaceholderValue()
private
static resolvePlaceholderValue(mixed $value) : mixed
Parameters
- $value : mixed