Detailed Description
AbstractFormat maybe used as base class for specialized formats.
Definition at line 27 of file AbstractFormat.php.
Public Member Functions | |
deserialize (Request $request) | |
serialize (Response $response) | |
Public Member Functions inherited from Format | |
getMimeType () | |
Protected Member Functions | |
getRequest () | |
getResponse () | |
beforeDeserialize ($values) | |
deserializeValues ($values) | |
afterDeserialize ($values) | |
beforeSerialize ($values) | |
serializeValues ($values) | |
afterSerialize ($values) | |
getNode (ObjectId $oid) | |
filterValue ($value, AttributeDescription $attribute) | |
Member Function Documentation
deserialize | ( | Request | $request | ) |
serialize | ( | Response | $response | ) |
|
protected |
Get the currently deserialized request.
- Returns
- Request
Definition at line 61 of file AbstractFormat.php.
|
protected |
Get the currently deserialized response.
- Returns
- Response
Definition at line 69 of file AbstractFormat.php.
|
protected |
Modify data before deserialization.
The default implementation does nothing.
- Parameters
-
$values The request values
- Returns
- The modified values array
- Note
- Subclasses override this if necessary
Definition at line 79 of file AbstractFormat.php.
|
abstractprotected |
Deserialize an array of values.
- Parameters
-
$values The array/object of values
- Returns
- The array/object of values
|
protected |
Modify data after deserialization.
The default implementation does nothing.
- Parameters
-
$values The request values
- Returns
- The modified values array
- Note
- Subclasses override this if necessary
Definition at line 96 of file AbstractFormat.php.
|
protected |
Modify data before serialization.
The default implementation does nothing.
- Parameters
-
$values The response values
- Returns
- The modified values array
- Note
- Subclasses override this if necessary
Definition at line 106 of file AbstractFormat.php.
|
abstractprotected |
Serialize an array of values.
- Parameters
-
$values The array/object of values
- Returns
- The array/object of values
|
protected |
Modify data after serialization.
The default implementation does nothing.
- Parameters
-
$values The response values
- Returns
- The modified values array
- Note
- Subclasses override this if necessary
Definition at line 123 of file AbstractFormat.php.
|
protected |
Helper methods.
Get a node with the given oid to deserialize values from form fields into it. The method ensures that there is only one instance per oid.
- Parameters
-
$oid The oid
- Returns
- A reference to the Node instance
Definition at line 137 of file AbstractFormat.php.
|
protected |
Definition at line 156 of file AbstractFormat.php.