AfsFilterCoder Class Reference

Default filter coder implementation. More...

Inheritance diagram for AfsFilterCoder:

Public Member Functions
	__construct ($value_separator='_', $filter_separator='-', $escape_character='|')
	Construct new instance.
	encode (array $filters)
	Encode filters.
	decode ($filters)
	Decode filters from string.
Public Member Functions inherited from AfsCoderBase
	__construct ($escape_character, $regex_delimiter='~')
	Construct instance with appropriate escape and regex delimiter characters.

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 filter coder implementation.

Constructor & Destructor Documentation

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

Construct new instance.

Parameters

$value_separator	[in] character used to separate values for each filter.
$filter_separator	[in] character used to separate filters.
$escape_character	[in] character to escape character when filters or values cointains one of the previous separator.

Exceptions

InvalidArgumentException

when value_separator, filter_separator and escape_character are not strictly different.

Member Function Documentation

decode

(

$filters

)

Decode filters from string.

Parameters

$filters

[in] string representing list of filters with their values.

Returns

List of filters with their values.

Implements AfsCoderInterface.

encode

(

array

$filters

)

Encode filters.

Parameters

$filters

[in] List of filters with their values.

Returns

string encoded filters

Implements AfsCoderInterface.