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.

string
getPath()

Returns the path of the node.

Boolean
isRequired()

Returns true when the node is required.

Boolean
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.

setName(string $name)

Sets the name of the node.

Details

in NodeInterface at line line 29
string getName()

Returns the name of the node.

Return Value

string The name of the node

in NodeInterface at line line 36
string getPath()

Returns the path of the node.

Return Value

string The node path

in NodeInterface at line line 43
Boolean isRequired()

Returns true when the node is required.

Return Value

Boolean If the node is required

in NodeInterface at line line 50
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 line 58
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 line 67
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 line 77
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 line 86
mixed finalize(mixed $value)

Finalizes a value.

Parameters

mixed $value The value to finalize

Return Value

mixed The finalized value

at line line 26
setName(string $name)

Sets the name of the node.

Parameters

string $name The name of the node