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

ServerBag

class ServerBag extends ParameterBag

ServerBag is a container for HTTP headers from the $_SERVER variable.

Methods

__construct(array $parameters = array())

Constructor.

from ParameterBag
array
all()

Returns the parameters.

from ParameterBag
array
keys()

Returns the parameter keys.

from ParameterBag
replace(array $parameters = array())

Replaces the current parameters by a new set.

from ParameterBag
add(array $parameters = array())

Adds parameters.

from ParameterBag
mixed
get(string $key, mixed $default = null, bool $deep = false)

Returns a parameter by name.

from ParameterBag
set(string $key, mixed $value)

Sets a parameter by name.

from ParameterBag
bool
has(string $key)

Returns true if the parameter is defined.

from ParameterBag
remove(string $key)

Removes a parameter.

from ParameterBag
string
getAlpha(string $key, string $default = '', bool $deep = false)

Returns the alphabetic characters of the parameter value.

from ParameterBag
string
getAlnum(string $key, string $default = '', bool $deep = false)

Returns the alphabetic characters and digits of the parameter value.

from ParameterBag
string
getDigits(string $key, string $default = '', bool $deep = false)

Returns the digits of the parameter value.

from ParameterBag
int
getInt(string $key, int $default, bool $deep = false)

Returns the parameter value converted to integer.

from ParameterBag
bool
getBoolean(string $key, mixed $default = false, bool $deep = false)

Returns the parameter value converted to boolean.

from ParameterBag
mixed
filter(string $key, mixed $default = null, int $filter = FILTER_DEFAULT, mixed $options = array(), bool $deep = false)

Filter key.

from ParameterBag
ArrayIterator
getIterator()

Returns an iterator for parameters.

from ParameterBag
int
count()

Returns the number of parameters.

from ParameterBag
array
getHeaders()

Gets the HTTP headers.

Details

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

Constructor.

Parameters

array $parameters An array of parameters

in ParameterBag at line line 43
array all()

Returns the parameters.

Return Value

array An array of parameters

in ParameterBag at line line 53
array keys()

Returns the parameter keys.

Return Value

array An array of parameter keys

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

Replaces the current parameters by a new set.

Parameters

array $parameters An array of parameters

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

Adds parameters.

Parameters

array $parameters An array of parameters

in ParameterBag at line line 91
mixed get(string $key, mixed $default = null, bool $deep = false)

Returns a parameter by name.

Note: Finding deep items is deprecated since version 2.8, to be removed in 3.0.

Parameters

string $key The key
mixed $default The default value if the parameter key does not exist
bool $deep If true, a path like foo[bar] will find deeper items

Return Value

mixed

Exceptions

InvalidArgumentException

in ParameterBag at line line 150
set(string $key, mixed $value)

Sets a parameter by name.

Parameters

string $key The key
mixed $value The value

in ParameterBag at line line 162
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

in ParameterBag at line line 172
remove(string $key)

Removes a parameter.

Parameters

string $key The key

in ParameterBag at line line 186
string getAlpha(string $key, string $default = '', bool $deep = false)

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
bool $deep If true, a path like foo[bar] will find deeper items

Return Value

string The filtered value

in ParameterBag at line line 200
string getAlnum(string $key, string $default = '', bool $deep = false)

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
bool $deep If true, a path like foo[bar] will find deeper items

Return Value

string The filtered value

in ParameterBag at line line 214
string getDigits(string $key, string $default = '', bool $deep = false)

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
bool $deep If true, a path like foo[bar] will find deeper items

Return Value

string The filtered value

in ParameterBag at line line 229
int getInt(string $key, int $default, bool $deep = false)

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
bool $deep If true, a path like foo[bar] will find deeper items

Return Value

int The filtered value

in ParameterBag at line line 243
bool getBoolean(string $key, mixed $default = false, bool $deep = 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
bool $deep If true, a path like foo[bar] will find deeper items

Return Value

bool The filtered value

in ParameterBag at line line 261
mixed filter(string $key, mixed $default = null, int $filter = FILTER_DEFAULT, mixed $options = array(), bool $deep = false)

Filter key.

Parameters

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

Return Value

mixed

See also

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

in ParameterBag at line line 298
ArrayIterator getIterator()

Returns an iterator for parameters.

Return Value

ArrayIterator An \ArrayIterator instance

in ParameterBag at line line 308
int count()

Returns the number of parameters.

Return Value

int The number of parameters

at line line 28
array getHeaders()

Gets the HTTP headers.

Return Value

array