1. class
  2. Symfony
  3. Component
  4. HttpFoundation
  5. ParameterBag

ParameterBag

class ParameterBag implements IteratorAggregate, Countable

ParameterBag is a container for key/value pairs.

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

at line line 33
__construct(array $parameters = array())

Constructor.

Parameters

array $parameters An array of parameters

at line line 43
array all()

Returns the parameters.

Return Value

array An array of parameters

at line line 53
array keys()

Returns the parameter keys.

Return Value

array An array of parameter keys

at line line 63
replace(array $parameters = array())

Replaces the current parameters by a new set.

Parameters

array $parameters An array of parameters

at line line 73
add(array $parameters = array())

Adds parameters.

Parameters

array $parameters An array of parameters

at line line 88
mixed get(string $key, mixed $default = null)

Returns a parameter by name.

Parameters

string $key The key
mixed $default The default value if the parameter key does not exist

Return Value

mixed

Exceptions

InvalidArgumentException

at line line 99
set(string $key, mixed $value)

Sets a parameter by name.

Parameters

string $key The key
mixed $value The value

at line line 111
bool has(string $key)

Returns true if the parameter is defined.

Parameters

string $key The key

Return Value

bool true if the parameter exists, false otherwise

at line line 121
remove(string $key)

Removes a parameter.

Parameters

string $key The key

at line line 134
string getAlpha(string $key, string $default = '')

Returns the alphabetic characters of the parameter value.

Parameters

string $key The parameter key
string $default The default value if the parameter key does not exist

Return Value

string The filtered value

at line line 147
string getAlnum(string $key, string $default = '')

Returns the alphabetic characters and digits of the parameter value.

Parameters

string $key The parameter key
string $default The default value if the parameter key does not exist

Return Value

string The filtered value

at line line 160
string getDigits(string $key, string $default = '')

Returns the digits of the parameter value.

Parameters

string $key The parameter key
string $default The default value if the parameter key does not exist

Return Value

string The filtered value

at line line 174
int getInt(string $key, int $default)

Returns the parameter value converted to integer.

Parameters

string $key The parameter key
int $default The default value if the parameter key does not exist

Return Value

int The filtered value

at line line 187
bool getBoolean(string $key, mixed $default = false)

Returns the parameter value converted to boolean.

Parameters

string $key The parameter key
mixed $default The default value if the parameter key does not exist

Return Value

bool The filtered value

at line line 204
mixed filter(string $key, mixed $default = null, int $filter = FILTER_DEFAULT, mixed $options = array())

Filter key.

Parameters

string $key Key.
mixed $default Default = null.
int $filter FILTER_* constant.
mixed $options Filter options.

Return Value

mixed

See also

http://php.net/manual/en/function.filter-var.php

at line line 226
ArrayIterator getIterator()

Returns an iterator for parameters.

Return Value

ArrayIterator An \ArrayIterator instance

at line line 236
int count()

Returns the number of parameters.

Return Value

int The number of parameters