HierarchicalFormat Class Reference

Detailed Description

HierarchicalFormat maybe used as base class for formats that are able to represent hierarchical data like JSON or XML.

This format automatically iterates over data when de-/serializing and uses template methods to implement the specific format.

Author

ingo herwig ingo@.nosp@m.wemo.nosp@m.ve.co.nosp@m.m

Definition at line 25 of file HierarchicalFormat.php.

Inheritance diagram for HierarchicalFormat:

Protected Member Functions
	deserializeValues ($values)
	serializeValues ($values)
	isSerializedNode ($value)
	isDeserializedNode ($value)
	serializeNode ($value)
	deserializeNode ($value)
Protected Member Functions inherited from AbstractFormat
	getRequest ()
	getResponse ()
	beforeDeserialize ($values)
	deserializeValues ($values)
	afterDeserialize ($values)
	beforeSerialize ($values)
	serializeValues ($values)
	afterSerialize ($values)
	getNode (ObjectId $oid)
	filterValue ($value, AttributeDescription $attribute)

Additional Inherited Members
Public Member Functions inherited from AbstractFormat
	deserialize (Request $request)
	serialize (Response $response)
Public Member Functions inherited from Format
	getMimeType ()

Member Function Documentation

deserializeValues (   $values )

protected

See also

AbstractFormat::deserializeValues()

Definition at line 30 of file HierarchicalFormat.php.

serializeValues (   $values )

protected

See also

AbstractFormat::serializeValues()

Definition at line 65 of file HierarchicalFormat.php.

isSerializedNode (   $value )

protected

Determine if the value is a serialized Node.

The default implementation returns false.

Parameters

$value

The data value

Returns

Boolean

Note

Subclasses override this if necessary

Definition at line 98 of file HierarchicalFormat.php.

isDeserializedNode (   $value )

protected

Determine if the value is a deserialized Node.

The default implementation checks if the value is an object of type Node.

Parameters

$value

The data value

Returns

Boolean

Note

Subclasses override this if necessary

Definition at line 109 of file HierarchicalFormat.php.

serializeNode (   $value )

abstractprotected

Serialize a Node.

Parameters

$value

The data value

Returns

The serialized Node

deserializeNode (   $value )

abstractprotected

Deserialize a Node.

Parameters

$value

The data value

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