Interface

Symfony\Component\Config\Definition\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
Boolean isRequired()

Returns true when the node is required.

from NodeInterface
Boolean 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 the supplied 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

in NodeInterface at line 29
public string getName()

Returns the name of the node.

Return Value

string The name of the node

in NodeInterface at line 36
public string getPath()

Returns the path of the node.

Return Value

string The node path

in NodeInterface at line 43
public Boolean isRequired()

Returns true when the node is required.

Return Value

Boolean If the node is required

in NodeInterface at line 50
public Boolean hasDefaultValue()

Returns true when the node has a default value.

Return Value

Boolean If the node has a default value

in NodeInterface at line 58
public mixed getDefaultValue()

Returns the default value of the node.

Return Value

mixed The default value

Exceptions

RuntimeException if the node has no default value

in NodeInterface at line 67
public mixed normalize(mixed $value)

Normalizes the supplied value.

Parameters

mixed $value The value to normalize

Return Value

mixed The normalized value

in NodeInterface at line 77
public mixed merge(mixed $leftSide, mixed $rightSide)

Merges two values together.

Parameters

mixed $leftSide
mixed $rightSide

Return Value

mixed The merged values

in NodeInterface at line 86
public mixed finalize(mixed $value)

Finalizes a value.

Parameters

mixed $value The value to finalize

Return Value

mixed The finalized value

at line 26
public setName(string $name)

Sets the name of the node.

Parameters

string $name The name of the node