NodeSerializer Interface Reference
Detailed Description
NodeSerializer implementations are used to serialize Nodes into an array representation or deserialize an array representation into Nodes.
Definition at line 21 of file NodeSerializer.php.
Inheritance diagram for NodeSerializer:Public Member Functions | |
| isSerializedNode ($data) | |
| deserializeNode ($data, Node $parent=null, $role=null) | |
| serializeNode ($node) | |
Member Function Documentation
| isSerializedNode | ( | $data | ) |
Check if the given data represent a serialized Node.
- Parameters
-
$data A variable of any type
- Returns
- Boolean
Implemented in DionysosNodeSerializer, DojoNodeSerializer, and SoapNodeSerializer.
| deserializeNode | ( | $data, | |
| Node | $parent = null, |
||
$role = null |
|||
| ) |
Deserialize a Node from serialized data.
Only values given in data are being set.
- Parameters
-
$data An array containing the serialized Node data $parent The parent Node (default: null) $role The role of the serialized Node in relation to parent (default: null)
- Returns
- An array with keys 'node' and 'data' where the node value is the Node instance and the data value is the remaining part of data, that is not used for deserializing the Node
Implemented in DionysosNodeSerializer, DojoNodeSerializer, and SoapNodeSerializer.
| serializeNode | ( | $node | ) |
Serialize a Node into an array.
- Parameters
-
$node A reference to the node to serialize
- Returns
- The node serialized into an associated array
Implemented in DionysosNodeSerializer, and SoapNodeSerializer.