AfsCoderBase Class Reference

Base class for coders. More...

Inheritance diagram for AfsCoderBase:

Public Member Functions
	__construct ($escape_character, $regex_delimiter='~')
	Construct instance with appropriate escape and regex delimiter characters.

Protected Member Functions
	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

Base class for coders.

Implements usefull methods to simplify encode/decode methods.

Constructor & Destructor Documentation

__construct	(		$escape_character,
			$regex_delimiter = '~'
	)

Construct instance with appropriate escape and regex delimiter characters.

Parameters

$escape_character	[in] character used when values contain characters with specific meaning (eg: separator)
$regex_delimiter	[in] character used as delimiters in regular expression.

Reimplemented in AfsFeedCoder, and AfsSortCoder.

Member Function Documentation

check_unicity ( array  $params )

protected

Check unicity of provided params.

Parameters

$params

[in] list of parameters to be checked.

Exceptions

InvalidArgumentException

when params are not unique.

explode (   $sep,   $value  )

protected

Split provided value.

Input value is splitted on each character separator sep except when it is preceded by escape character.

Remarks

escape characters which have been escaped should be unescaped by appropriate function call.

Parameters

$sep	[in] separator used to split input value.
$value	[in] value to be splitted.

Returns

splitted value.

replace (   $pattern,   $replacement,   $value  )

protected

Simple wrapper which add surrounding regex delimiters.

Parameters

$pattern	[in] regex pattern to use (already quoted).
$replacement	[in] replacement.
$value	[in] value to modify.

Returns

updated value.