AfsCoderInterface Interface Reference

Interface for encoding/decoding parameters. More...

Inheritance diagram for AfsCoderInterface:

Public Member Functions
	encode (array $parameters)
	Encode parameters.
	decode ($parameters)
	Decode previously encoded parameters.

Detailed Description

Interface for encoding/decoding parameters.

Encoding parameters results in a string which should be decoded in order to retrieve original data.

Example for filters:

$filters = $query->get_parameters()['filter'];
$coder = new FilterCoder(); // implements AfsCoderInterface
$coded_filters = $coder->encode($filters);
$decoded_filters = $coder->decode($filters);
assert($filters == $decoded_filters);

Member Function Documentation

decode

(

$parameters

)

Decode previously encoded parameters.

Parameters

$parameters

[in] encoded string representing parameters.

Returns

decoded parameters.

Implemented in AfsFilterCoder, AfsSortCoder, and AfsFeedCoder.

encode

(

array

$parameters

)

Encode parameters.

Parameters

$parameters

[in] array of parameters.

Returns

encoded string.

Implemented in AfsFilterCoder, AfsFeedCoder, and AfsSortCoder.