FloatNode

class FloatNode extends NumericNode

This node represents a float value in the config tree.

Methods

__construct(string $name, NodeInterface $parent = null, $min = null, $max = null)

Constructor.

from NumericNode
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

__construct(string $name, NodeInterface $parent = null, $min = null, $max = null)

Constructor.

Parameters

string $name The name of the node
NodeInterface $parent The parent of this node
$min
$max

Exceptions

InvalidArgumentException if the name contains a period.

setAttribute($key, $value)

Parameters

$key
$value

getAttribute($key, $default = null)

Parameters

$key
$default

hasAttribute($key)

Parameters

$key

getAttributes()

setAttributes(array $attributes)

Parameters

array $attributes

removeAttribute($key)

Parameters

$key

setInfo(string $info)

Sets an info message.

Parameters

string $info

string getInfo()

Returns info message.

Return Value

string The info text

setExample(string|array $example)

Sets the example configuration for this node.

Parameters

string|array $example

string|array getExample()

Retrieves the example configuration for this node.

Return Value

string|array The example

addEquivalentValue(mixed $originalValue, mixed $equivalentValue)

Adds an equivalent value.

Parameters

mixed $originalValue
mixed $equivalentValue

setRequired(bool $boolean)

Set this node as required.

Parameters

bool $boolean Required node

setAllowOverwrite(bool $allow)

Sets if this node can be overridden.

Parameters

bool $allow

setNormalizationClosures(array $closures)

Sets the closures used for normalization.

Parameters

array $closures An array of Closures used for normalization

setFinalValidationClosures(array $closures)

Sets the closures used for final validation.

Parameters

array $closures An array of Closures used for final validation

bool isRequired()

Checks if this node is required.

Return Value

bool If the node is required

string getName()

Returns the name of this node

Return Value

string The name of the node

string getPath()

Retrieves the path of this node.

Return Value

string The node path

final mixed merge(mixed $leftSide, mixed $rightSide)

Merges two values together.

Parameters

mixed $leftSide
mixed $rightSide

Return Value

mixed The merged values

Exceptions

ForbiddenOverwriteException

final mixed normalize(mixed $value)

Normalizes a value, applying all normalization closures.

Parameters

mixed $value The value to normalize

Return Value

mixed The normalized value

NodeInterface|null getParent()

Returns parent node for this node.

Return Value

NodeInterface|null

final mixed finalize(mixed $value)

Finalizes a value, applying all finalization closures.

Parameters

mixed $value The value to finalize

Return Value

mixed The finalized value

Exceptions

Exception
InvalidConfigurationException

setDefaultValue($value)

{@inheritdoc}

Parameters

$value

bool hasDefaultValue()

Returns true when the node has a default value.

Return Value

bool If the node has a default value

mixed getDefaultValue()

Returns the default value of the node.

Return Value

mixed The default value

Exceptions

RuntimeException if the node has no default value

setAllowEmptyValue(bool $boolean)

Sets if this node is allowed to have an empty value.

Parameters

bool $boolean True if this entity will accept empty values.

setName(string $name)

Sets the name of the node.

Parameters

string $name The name of the node

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Config/Definition/FloatNode.html