\Symfony\Component\HttpFoundationParameterBag

ParameterBag is a container for key/value pairs.

Summary

Methods

Properties

Constants

__construct()
all()
keys()
replace()
add()
get()
set()
has()
remove()
getAlpha()
getAlnum()
getDigits()
getInt()
getBoolean()
filter()
getIterator()
count()

No public properties found

No constants found

No protected methods found

$parameters

N/A

No private methods found

No private properties found

N/A

File: vendor/symfony/http-foundation/ParameterBag.php
Package: Default
Class hierarchy: \Symfony\Component\HttpFoundation\ParameterBag
Implements

Properties

$parameters

$parameters :

Parameter storage.

Type

Methods

__construct()

__construct(array  $parameters = array())

Parameters

array

$parameters

all()

all() : array

Returns the parameters.

Returns

array —

An array of parameters

keys()

keys() : array

Returns the parameter keys.

Returns

array —

An array of parameter keys

replace()

replace(array  $parameters = array())

Replaces the current parameters by a new set.

Parameters

array

$parameters

add()

add(array  $parameters = array())

Adds parameters.

Parameters

array

$parameters

get()

get(\Symfony\Component\HttpFoundation\string  $key, mixed  $default = null) : mixed

Returns a parameter by name.

Parameters

\Symfony\Component\HttpFoundation\string	$key
mixed	$default	The default value if the parameter key does not exist

Returns

mixed

set()

set(\Symfony\Component\HttpFoundation\string  $key, mixed  $value)

Sets a parameter by name.

Parameters

\Symfony\Component\HttpFoundation\string	$key
mixed	$value	The value

has()

has(\Symfony\Component\HttpFoundation\string  $key) : boolean

Returns true if the parameter is defined.

Parameters

\Symfony\Component\HttpFoundation\string

$key

Returns

boolean —

true if the parameter exists, false otherwise

remove()

remove(\Symfony\Component\HttpFoundation\string  $key)

Removes a parameter.

Parameters

\Symfony\Component\HttpFoundation\string

$key

getAlpha()

getAlpha(\Symfony\Component\HttpFoundation\string  $key, \Symfony\Component\HttpFoundation\string  $default = '') : string

Returns the alphabetic characters of the parameter value.

Parameters

\Symfony\Component\HttpFoundation\string	$key
\Symfony\Component\HttpFoundation\string	$default

Returns

string —

The filtered value

getAlnum()

getAlnum(\Symfony\Component\HttpFoundation\string  $key, \Symfony\Component\HttpFoundation\string  $default = '') : string

Returns the alphabetic characters and digits of the parameter value.

Parameters

\Symfony\Component\HttpFoundation\string	$key
\Symfony\Component\HttpFoundation\string	$default

Returns

string —

The filtered value

getDigits()

getDigits(\Symfony\Component\HttpFoundation\string  $key, \Symfony\Component\HttpFoundation\string  $default = '') : string

Returns the digits of the parameter value.

Parameters

\Symfony\Component\HttpFoundation\string	$key
\Symfony\Component\HttpFoundation\string	$default

Returns

string —

The filtered value

getInt()

getInt(\Symfony\Component\HttpFoundation\string  $key, \Symfony\Component\HttpFoundation\int  $default) : integer

Returns the parameter value converted to integer.

Parameters

\Symfony\Component\HttpFoundation\string	$key
\Symfony\Component\HttpFoundation\int	$default

Returns

integer —

The filtered value

getBoolean()

getBoolean(\Symfony\Component\HttpFoundation\string  $key, \Symfony\Component\HttpFoundation\bool  $default = false) : boolean

Returns the parameter value converted to boolean.

Parameters

\Symfony\Component\HttpFoundation\string	$key
\Symfony\Component\HttpFoundation\bool	$default

Returns

boolean —

The filtered value

filter()

filter(\Symfony\Component\HttpFoundation\string  $key, mixed  $default = null, integer  $filter = \FILTER_DEFAULT, mixed  $options = array()) : mixed

Filter key.

Parameters

\Symfony\Component\HttpFoundation\string	$key
mixed	$default	Default = null
integer	$filter	FILTER_* constant
mixed	$options	Filter options

Returns

mixed

getIterator()

getIterator() : \ArrayIterator

Returns an iterator for parameters.

Returns

\ArrayIterator —

An \ArrayIterator instance

count()

count() : integer

Returns the number of parameters.

Returns

integer —

The number of parameters