Symfony\Component\HttpFoundation\ParameterBag

class ParameterBag implements IteratorAggregate, Countable

Methods

	__construct(array $parameters = array()) Constructor.
array	all() Returns the parameters.
array	keys() Returns the parameter keys.
	replace(array $parameters = array()) Replaces the current parameters by a new set.
	add(array $parameters = array()) Adds parameters.
mixed	get(string $key, mixed $default = null) Returns a parameter by name.
	set(string $key, mixed $value) Sets a parameter by name.
bool	has(string $key) Returns true if the parameter is defined.
	remove(string $key) Removes a parameter.
string	getAlpha(string $key, string $default = '') Returns the alphabetic characters of the parameter value.
string	getAlnum(string $key, string $default = '') Returns the alphabetic characters and digits of the parameter value.
string	getDigits(string $key, string $default = '') Returns the digits of the parameter value.
int	getInt(string $key, int $default) Returns the parameter value converted to integer.
bool	getBoolean(string $key, mixed $default = false) Returns the parameter value converted to boolean.
mixed	filter(string $key, mixed $default = null, int $filter = FILTER_DEFAULT, mixed $options = array()) Filter key.
ArrayIterator	getIterator() Returns an iterator for parameters.
int	count() Returns the number of parameters.

Details

public __construct(array $parameters = array())

Constructor.

public array all()

Returns the parameters.

public array keys()

Returns the parameter keys.

public replace(array $parameters = array())

Replaces the current parameters by a new set.

public add(array $parameters = array())

Adds parameters.

public mixed get(string $key, mixed $default = null)

Returns a parameter by name.

public set(string $key, mixed $value)

Sets a parameter by name.

public bool has(string $key)

Returns true if the parameter is defined.

public remove(string $key)

Removes a parameter.

public string getAlpha(string $key, string $default = '')

Returns the alphabetic characters of the parameter value.

public string getAlnum(string $key, string $default = '')

Returns the alphabetic characters and digits of the parameter value.

public string getDigits(string $key, string $default = '')

Returns the digits of the parameter value.

public int getInt(string $key, int $default)

Returns the parameter value converted to integer.

public bool getBoolean(string $key, mixed $default = false)

Returns the parameter value converted to boolean.

public mixed filter(string $key, mixed $default = null, int $filter = FILTER_DEFAULT, mixed $options = array())

Filter key.

public ArrayIterator getIterator()

Returns an iterator for parameters.

public int count()

Returns the number of parameters.