W3cubDocs

/Symfony 4.1

PrototypeNodeInterface

interface PrototypeNodeInterface implements NodeInterface

This interface must be implemented by nodes which can be used as prototypes.

Methods

string getName()

Returns the name of the node.

from NodeInterface
string getPath()

Returns the path of the node.

from NodeInterface
bool isRequired()

Returns true when the node is required.

from NodeInterface
bool hasDefaultValue()

Returns true when the node has a default value.

from NodeInterface
mixed getDefaultValue()

Returns the default value of the node.

from NodeInterface
mixed normalize(mixed $value)

Normalizes a value.

from NodeInterface
mixed merge(mixed $leftSide, mixed $rightSide)

Merges two values together.

from NodeInterface
mixed finalize(mixed $value)

Finalizes a value.

from NodeInterface
setName(string $name)

Sets the name of the node.

Details

string getName()

Returns the name of the node.

Return Value

string The name of the node

string getPath()

Returns the path of the node.

Return Value

string The node path

bool isRequired()

Returns true when the node is required.

Return Value

bool If the node is required

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

mixed normalize(mixed $value)

Normalizes a value.

Parameters

mixed $value The value to normalize

Return Value

mixed The normalized value

Exceptions

InvalidTypeException if the value type is invalid

mixed merge(mixed $leftSide, mixed $rightSide)

Merges two values together.

Parameters

mixed $leftSide
mixed $rightSide

Return Value

mixed The merged value

Exceptions

ForbiddenOverwriteException if the configuration path cannot be overwritten
InvalidTypeException if the value type is invalid

mixed finalize(mixed $value)

Finalizes a value.

Parameters

mixed $value The value to finalize

Return Value

mixed The finalized value

Exceptions

InvalidTypeException if the value type is invalid
InvalidConfigurationException if the value is invalid configuration

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.
https://api.symfony.com/4.1/Symfony/Component/Config/Definition/PrototypeNodeInterface.html