NodeInterface
in
Common Interface among all nodes.
In most cases, it is better to inherit from BaseNode instead of implementing this interface yourself.
Tags
Table of Contents
- finalize() : mixed
- Finalizes a value.
- getDefaultValue() : mixed
- Returns the default value of the node.
- getName() : string
- Returns the name of the node.
- getPath() : string
- Returns the path of the node.
- hasDefaultValue() : bool
- Returns true when the node has a default value.
- isRequired() : bool
- Returns true when the node is required.
- merge() : mixed
- Merges two values together.
- normalize() : mixed
- Normalizes a value.
Methods
finalize()
Finalizes a value.
public
finalize(mixed $value) : mixed
Parameters
- $value : mixed
-
The value to finalize
Tags
Return values
mixed —The finalized value
getDefaultValue()
Returns the default value of the node.
public
getDefaultValue() : mixed
Tags
Return values
mixed —The default value
getName()
Returns the name of the node.
public
getName() : string
Return values
string —The name of the node
getPath()
Returns the path of the node.
public
getPath() : string
Return values
string —The node path
hasDefaultValue()
Returns true when the node has a default value.
public
hasDefaultValue() : bool
Return values
bool —If the node has a default value
isRequired()
Returns true when the node is required.
public
isRequired() : bool
Return values
bool —If the node is required
merge()
Merges two values together.
public
merge(mixed $leftSide, mixed $rightSide) : mixed
Parameters
- $leftSide : mixed
- $rightSide : mixed
Tags
Return values
mixed —The merged value
normalize()
Normalizes a value.
public
normalize(mixed $value) : mixed
Parameters
- $value : mixed
-
The value to normalize
Tags
Return values
mixed —The normalized value