AfsSortCoder Class Reference

Default sort coder implementation. More...

Inheritance diagram for AfsSortCoder:

Public Member Functions
	__construct ($value_separator='_', $escape_character='|')
	Construct new instance.
	encode (array $sorts)
	Encodes sort parameters.
	decode ($sorts)
	Decodes sort parameters from string.

Additional Inherited Members
Protected Member Functions inherited from AfsCoderBase
	check_unicity (array $params)
	Check unicity of provided params.
	explode ($sep, $value)
	Split provided value.
	replace ($pattern, $replacement, $value)
	Simple wrapper which add surrounding regex delimiters.

Detailed Description

Default sort coder implementation.

Constructor & Destructor Documentation

__construct	(		$value_separator = '_',
			$escape_character = '|'
	)

Construct new instance.

Parameters

$value_separator	[in] character used to separate values.
$escape_character	[in] character to escape character when sort parameter contains previous separator.

Exceptions

InvalidArgumentException

when value_separator and escape_character are not strictly different.

Reimplemented from AfsCoderBase.

Member Function Documentation

decode

(

$sorts

)

Decodes sort parameters from string.

Parameters

$sorts

[in] string representing list of sort parameters.

Returns

list of sort parameters.

Exceptions

InvalidArgumentException

when provided sort value is malformed.

Implements AfsCoderInterface.

encode

(

array

$sorts

)

Encodes sort parameters.

Parameters

$sorts

[in] List of sort parameters.

Returns

string encoded of sort parameters.

Implements AfsCoderInterface.