PrototypeNodeInterface
extends
NodeInterface
in
This interface must be implemented by nodes which can be used as prototypes.
Tags
Table of Contents
Methods
- 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.
- setName() : mixed
- Sets the name of the node.
Methods
finalize()
Finalizes a value.
public
finalize(mixed $value) : mixed
Parameters
- $value : mixed
Tags
getDefaultValue()
Returns the default value of the node.
public
getDefaultValue() : mixed
Tags
getName()
Returns the name of the node.
public
getName() : string
Return values
stringgetPath()
Returns the path of the node.
public
getPath() : string
Return values
stringhasDefaultValue()
Returns true when the node has a default value.
public
hasDefaultValue() : bool
Return values
boolisRequired()
Returns true when the node is required.
public
isRequired() : bool
Return values
boolmerge()
Merges two values together.
public
merge(mixed $leftSide, mixed $rightSide) : mixed
Parameters
- $leftSide : mixed
- $rightSide : mixed
Tags
normalize()
Normalizes a value.
public
normalize(mixed $value) : mixed
Parameters
- $value : mixed
Tags
setName()
Sets the name of the node.
public
setName(string $name) : mixed
Parameters
- $name : string