Interface

Symfony\Component\Config\Definition\NodeInterface

interface NodeInterface

Common Interface among all nodes.

In most cases, it is better to inherit from BaseNode instead of implementing this interface yourself.

Methods

string getName()

Returns the name of the node.

string getPath()

Returns the path of the node.

bool isRequired()

Returns true when the node is required.

bool hasDefaultValue()

Returns true when the node has a default value.

mixed getDefaultValue()

Returns the default value of the node.

mixed normalize(mixed $value)

Normalizes the supplied value.

mixed merge(mixed $leftSide, mixed $rightSide)

Merges two values together.

mixed finalize(mixed $value)

Finalizes a value.

Details

at line 29
public string getName()

Returns the name of the node.

Return Value

string The name of the node

at line 36
public string getPath()

Returns the path of the node.

Return Value

string The node path

at line 43
public bool isRequired()

Returns true when the node is required.

Return Value

bool If the node is required

at line 50
public bool hasDefaultValue()

Returns true when the node has a default value.

Return Value

bool If the node has a default value

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

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

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

at line 86
public mixed finalize(mixed $value)

Finalizes a value.

Parameters

mixed $value The value to finalize

Return Value

mixed The finalized value