Inheritance diagram for Symfony\Component\HttpFoundation\ParameterBag:

Public Member Functions
	__construct (array $parameters=[])

	__construct (array $parameters=array())

	add (array $parameters=[])

	add (array $parameters=array())

	all ()

	all ()

	count ()

	count ()

	filter ($key, $default=null, $filter=FILTER_DEFAULT, $options=[])

	filter ($key, $default=null, $filter=FILTER_DEFAULT, $options=array())

	get ($key, $default=null)

	get ($key, $default=null)

	getAlnum ($key, $default='')

	getAlnum ($key, $default='')

	getAlpha ($key, $default='')

	getAlpha ($key, $default='')

	getBoolean ($key, $default=false)

	getBoolean ($key, $default=false)

	getDigits ($key, $default='')

	getDigits ($key, $default='')

	getInt ($key, $default=0)

	getInt ($key, $default=0)

	getIterator ()

	getIterator ()

	has ($key)

	has ($key)

	keys ()

	keys ()

	remove ($key)

	remove ($key)

	replace (array $parameters=[])

	replace (array $parameters=array())

	set ($key, $value)

	set ($key, $value)

Protected Attributes
	$parameters

Detailed Description

ParameterBag is a container for key/value pairs.

Author: Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Definition at line 19 of file lib/vendor/symfony/http-foundation/ParameterBag.php.

Constructor & Destructor Documentation

◆ __construct() [1/2]

Symfony\Component\HttpFoundation\ParameterBag::__construct ( array $parameters = array() )

Constructor.

Parameters

array $parameters An array of parameters

Reimplemented in Symfony\Component\HttpFoundation\FileBag, and Symfony\Component\HttpFoundation\FileBag.

Definition at line 36 of file lib/vendor/symfony/http-foundation/ParameterBag.php.

References Symfony\Component\HttpFoundation\ParameterBag\$parameters.

◆ __construct() [2/2]

Symfony\Component\HttpFoundation\ParameterBag::__construct ( array $parameters = [] )

Reimplemented in Symfony\Component\HttpFoundation\FileBag, and Symfony\Component\HttpFoundation\FileBag.

Definition at line 26 of file vendor/symfony/http-foundation/ParameterBag.php.

References Symfony\Component\HttpFoundation\ParameterBag\$parameters.

Member Function Documentation

◆ add() [1/2]

Symfony\Component\HttpFoundation\ParameterBag::add ( array $parameters = [] )

Adds parameters.

Reimplemented in Symfony\Component\HttpFoundation\FileBag, and Symfony\Component\HttpFoundation\FileBag.

Definition at line 62 of file vendor/symfony/http-foundation/ParameterBag.php.

References Symfony\Component\HttpFoundation\ParameterBag\$parameters.

◆ add() [2/2]

Symfony\Component\HttpFoundation\ParameterBag::add ( array $parameters = array() )

Adds parameters.

Parameters

array $parameters An array of parameters

Reimplemented in Symfony\Component\HttpFoundation\FileBag, and Symfony\Component\HttpFoundation\FileBag.

Definition at line 76 of file lib/vendor/symfony/http-foundation/ParameterBag.php.

References Symfony\Component\HttpFoundation\ParameterBag\$parameters.

◆ all() [1/2]

Symfony\Component\HttpFoundation\ParameterBag::all ( )

Returns the parameters.

Returns: array An array of parameters

Definition at line 36 of file vendor/symfony/http-foundation/ParameterBag.php.

References Symfony\Component\HttpFoundation\ParameterBag\$parameters.

◆ all() [2/2]

Symfony\Component\HttpFoundation\ParameterBag::all ( )

Returns the parameters.

Returns: array An array of parameters

Definition at line 46 of file lib/vendor/symfony/http-foundation/ParameterBag.php.

References Symfony\Component\HttpFoundation\ParameterBag\$parameters.

◆ count() [1/2]

Symfony\Component\HttpFoundation\ParameterBag::count ( )

Returns the number of parameters.

Returns: int The number of parameters

Definition at line 223 of file vendor/symfony/http-foundation/ParameterBag.php.

◆ count() [2/2]

Symfony\Component\HttpFoundation\ParameterBag::count ( )

Returns the number of parameters.

Returns: int The number of parameters

Definition at line 237 of file lib/vendor/symfony/http-foundation/ParameterBag.php.

Referenced by Symfony\Component\HttpFoundation\ServerBag\getHeaders().

◆ filter() [1/2]

Symfony\Component\HttpFoundation\ParameterBag::filter	(	$key,
		$default = `null`,
		$filter = `FILTER_DEFAULT`,
		$options = `[]`
	)

Filter key.

Parameters

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

See also: https://php.net/filter-var

Returns: mixed

Definition at line 191 of file vendor/symfony/http-foundation/ParameterBag.php.

◆ filter() [2/2]

Symfony\Component\HttpFoundation\ParameterBag::filter	(	$key,
		$default = `null`,
		$filter = `FILTER_DEFAULT`,
		$options = `array()`
	)

Filter key.

Parameters

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

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

Returns: mixed

Definition at line 205 of file lib/vendor/symfony/http-foundation/ParameterBag.php.

Referenced by Symfony\Component\HttpFoundation\ParameterBag\getBoolean(), and Symfony\Component\HttpFoundation\ParameterBag\getDigits().

◆ get() [1/2]

Symfony\Component\HttpFoundation\ParameterBag::get	(	$key,
		$default = `null`
	)

Returns a parameter by name.

Parameters

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

Returns: mixed

Definition at line 75 of file vendor/symfony/http-foundation/ParameterBag.php.

◆ get() [2/2]

Symfony\Component\HttpFoundation\ParameterBag::get	(	$key,
		$default = `null`
	)

Returns a parameter by name.

Parameters

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

Returns: mixed

Definition at line 89 of file lib/vendor/symfony/http-foundation/ParameterBag.php.

◆ getAlnum() [1/2]

Symfony\Component\HttpFoundation\ParameterBag::getAlnum	(	$key,
		$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

Returns: string The filtered value

Definition at line 134 of file vendor/symfony/http-foundation/ParameterBag.php.

◆ getAlnum() [2/2]

Symfony\Component\HttpFoundation\ParameterBag::getAlnum	(	$key,
		$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

Returns: string The filtered value

Definition at line 148 of file lib/vendor/symfony/http-foundation/ParameterBag.php.

◆ getAlpha() [1/2]

Symfony\Component\HttpFoundation\ParameterBag::getAlpha	(	$key,
		$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

Returns: string The filtered value

Definition at line 121 of file vendor/symfony/http-foundation/ParameterBag.php.

◆ getAlpha() [2/2]

Symfony\Component\HttpFoundation\ParameterBag::getAlpha	(	$key,
		$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

Returns: string The filtered value

Definition at line 135 of file lib/vendor/symfony/http-foundation/ParameterBag.php.

◆ getBoolean() [1/2]

Symfony\Component\HttpFoundation\ParameterBag::getBoolean	(	$key,
		$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

Returns: bool The filtered value

Definition at line 174 of file vendor/symfony/http-foundation/ParameterBag.php.

References Symfony\Component\HttpFoundation\ParameterBag\filter().

◆ getBoolean() [2/2]

Symfony\Component\HttpFoundation\ParameterBag::getBoolean	(	$key,
		$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

Returns: bool The filtered value

Definition at line 188 of file lib/vendor/symfony/http-foundation/ParameterBag.php.

References Symfony\Component\HttpFoundation\ParameterBag\filter().

◆ getDigits() [1/2]

Symfony\Component\HttpFoundation\ParameterBag::getDigits	(	$key,
		$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

Returns: string The filtered value

Definition at line 147 of file vendor/symfony/http-foundation/ParameterBag.php.

References Symfony\Component\HttpFoundation\ParameterBag\filter().

◆ getDigits() [2/2]

Symfony\Component\HttpFoundation\ParameterBag::getDigits	(	$key,
		$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

Returns: string The filtered value

Definition at line 161 of file lib/vendor/symfony/http-foundation/ParameterBag.php.

References Symfony\Component\HttpFoundation\ParameterBag\filter().

◆ getInt() [1/2]

Symfony\Component\HttpFoundation\ParameterBag::getInt	(	$key,
		$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

Returns: int The filtered value

Definition at line 161 of file vendor/symfony/http-foundation/ParameterBag.php.

◆ getInt() [2/2]

Symfony\Component\HttpFoundation\ParameterBag::getInt	(	$key,
		$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

Returns: int The filtered value

Definition at line 175 of file lib/vendor/symfony/http-foundation/ParameterBag.php.

◆ getIterator() [1/2]

Symfony\Component\HttpFoundation\ParameterBag::getIterator ( )

Returns an iterator for parameters.

Returns: \ArrayIterator An \ArrayIterator instance

Definition at line 213 of file vendor/symfony/http-foundation/ParameterBag.php.

◆ getIterator() [2/2]

Symfony\Component\HttpFoundation\ParameterBag::getIterator ( )

Returns an iterator for parameters.

Returns: \ArrayIterator An \ArrayIterator instance

Definition at line 227 of file lib/vendor/symfony/http-foundation/ParameterBag.php.

◆ has() [1/2]

Symfony\Component\HttpFoundation\ParameterBag::has ( $key )

Returns true if the parameter is defined.

Parameters

string $key The key

Returns: bool true if the parameter exists, false otherwise

Definition at line 98 of file vendor/symfony/http-foundation/ParameterBag.php.

◆ has() [2/2]

Symfony\Component\HttpFoundation\ParameterBag::has ( $key )

Returns true if the parameter is defined.

Parameters

string $key The key

Returns: bool true if the parameter exists, false otherwise

Definition at line 112 of file lib/vendor/symfony/http-foundation/ParameterBag.php.

◆ keys() [1/2]

Symfony\Component\HttpFoundation\ParameterBag::keys ( )

Returns the parameter keys.

Returns: array An array of parameter keys

Definition at line 46 of file vendor/symfony/http-foundation/ParameterBag.php.

◆ keys() [2/2]

Symfony\Component\HttpFoundation\ParameterBag::keys ( )

Returns the parameter keys.

Returns: array An array of parameter keys

Definition at line 56 of file lib/vendor/symfony/http-foundation/ParameterBag.php.

◆ remove() [1/2]

Symfony\Component\HttpFoundation\ParameterBag::remove ( $key )

Removes a parameter.

Parameters

string $key The key

Definition at line 108 of file vendor/symfony/http-foundation/ParameterBag.php.

◆ remove() [2/2]

Symfony\Component\HttpFoundation\ParameterBag::remove ( $key )

Removes a parameter.

Parameters

string $key The key

Definition at line 122 of file lib/vendor/symfony/http-foundation/ParameterBag.php.

◆ replace() [1/2]

Symfony\Component\HttpFoundation\ParameterBag::replace ( array $parameters = [] )

Replaces the current parameters by a new set.

Reimplemented in Symfony\Component\HttpFoundation\FileBag, and Symfony\Component\HttpFoundation\FileBag.

Definition at line 54 of file vendor/symfony/http-foundation/ParameterBag.php.

References Symfony\Component\HttpFoundation\ParameterBag\$parameters.

◆ replace() [2/2]

Symfony\Component\HttpFoundation\ParameterBag::replace ( array $parameters = array() )

Replaces the current parameters by a new set.

Parameters

array $parameters An array of parameters

Reimplemented in Symfony\Component\HttpFoundation\FileBag, and Symfony\Component\HttpFoundation\FileBag.

Definition at line 66 of file lib/vendor/symfony/http-foundation/ParameterBag.php.

References Symfony\Component\HttpFoundation\ParameterBag\$parameters.

◆ set() [1/2]

Symfony\Component\HttpFoundation\ParameterBag::set	(	$key,
		$value
	)

Sets a parameter by name.

Parameters

string	$key	The key
mixed	$value	The value

Reimplemented in Symfony\Component\HttpFoundation\FileBag, and Symfony\Component\HttpFoundation\FileBag.

Definition at line 86 of file vendor/symfony/http-foundation/ParameterBag.php.

◆ set() [2/2]

Symfony\Component\HttpFoundation\ParameterBag::set	(	$key,
		$value
	)

Sets a parameter by name.

Parameters

string	$key	The key
mixed	$value	The value

Reimplemented in Symfony\Component\HttpFoundation\FileBag, and Symfony\Component\HttpFoundation\FileBag.

Definition at line 100 of file lib/vendor/symfony/http-foundation/ParameterBag.php.

Referenced by Omnipay\Common\AbstractGateway\initialize().

Field Documentation

◆ $parameters

array Symfony\Component\HttpFoundation\ParameterBag::$parameters

protected

Parameter storage.

Definition at line 29 of file lib/vendor/symfony/http-foundation/ParameterBag.php.

Referenced by Symfony\Component\HttpFoundation\FileBag\__construct(), Symfony\Component\HttpFoundation\ParameterBag\__construct(), Symfony\Component\HttpFoundation\ParameterBag\add(), Symfony\Component\HttpFoundation\ParameterBag\all(), and Symfony\Component\HttpFoundation\ParameterBag\replace().

The documentation for this class was generated from the following file:

lib/vendor/symfony/http-foundation/ParameterBag.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct() [1/2]

◆ __construct() [2/2]

Member Function Documentation

◆ add() [1/2]

◆ add() [2/2]

◆ all() [1/2]

◆ all() [2/2]

◆ count() [1/2]

◆ count() [2/2]

◆ filter() [1/2]

◆ filter() [2/2]

◆ get() [1/2]

◆ get() [2/2]

◆ getAlnum() [1/2]

◆ getAlnum() [2/2]

◆ getAlpha() [1/2]

◆ getAlpha() [2/2]

◆ getBoolean() [1/2]

◆ getBoolean() [2/2]

◆ getDigits() [1/2]

◆ getDigits() [2/2]

◆ getInt() [1/2]

◆ getInt() [2/2]

◆ getIterator() [1/2]

◆ getIterator() [2/2]

◆ has() [1/2]

◆ has() [2/2]

◆ keys() [1/2]

◆ keys() [2/2]

◆ remove() [1/2]

◆ remove() [2/2]

◆ replace() [1/2]

◆ replace() [2/2]

◆ set() [1/2]

◆ set() [2/2]

Field Documentation

◆ $parameters