1. class
  2. Symfony
  3. \
  4. Component
  5. \
  6. HttpFoundation
  7. \
  8. ParameterBag

ParameterBag

class ParameterBag implements IteratorAggregate, Countable

ParameterBag is a container for key/value pairs.

Properties

protected $parameters Parameter storage.

Methods

__construct(array $parameters = array())

No description

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 = 0)

Returns the parameter value converted to integer.

bool
getBoolean(string $key, bool $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

__construct(array $parameters = array())

Parameters

array $parameters An array of parameters

array all()

Returns the parameters.

Return Value

array An array of parameters

array keys()

Returns the parameter keys.

Return Value

array An array of parameter keys

replace(array $parameters = array())

Replaces the current parameters by a new set.

Parameters

array $parameters An array of parameters

add(array $parameters = array())

Adds parameters.

Parameters

array $parameters An array of parameters

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

set(string $key, mixed $value)

Sets a parameter by name.

Parameters

string $key The key
mixed $value The value

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

remove(string $key)

Removes a parameter.

Parameters

string $key The key

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

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

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

int getInt(string $key, int $default = 0)

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

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

Returns the parameter value converted to boolean.

Parameters

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

Return Value

bool The filtered value

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

ArrayIterator getIterator()

Returns an iterator for parameters.

Return Value

ArrayIterator An \ArrayIterator instance

int count()

Returns the number of parameters.

Return Value

int The number of parameters