[ Index ]

PHP Cross Reference of phpBB-3.2.11-deutsch

title

Body

[close]

/vendor/symfony/http-foundation/ -> ParameterBag.php (summary)

(no description)

File Size: 308 lines (9 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

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


Class: ParameterBag  - X-Ref

ParameterBag is a container for key/value pairs.

__construct(array $parameters = array()   X-Ref

param: array $parameters An array of parameters

all()   X-Ref
Returns the parameters.

return: array An array of parameters

keys()   X-Ref
Returns the parameter keys.

return: array An array of parameter keys

replace(array $parameters = array()   X-Ref
Replaces the current parameters by a new set.

param: array $parameters An array of parameters

add(array $parameters = array()   X-Ref
Adds parameters.

param: array $parameters An array of parameters

get($key, $default = null, $deep = false)   X-Ref
Returns a parameter by name.

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

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

set($key, $value)   X-Ref
Sets a parameter by name.

param: string $key   The key
param: mixed  $value The value

has($key)   X-Ref
Returns true if the parameter is defined.

param: string $key The key
return: bool true if the parameter exists, false otherwise

remove($key)   X-Ref
Removes a parameter.

param: string $key The key

getAlpha($key, $default = '', $deep = false)   X-Ref
Returns the alphabetic characters of the parameter value.

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

getAlnum($key, $default = '', $deep = false)   X-Ref
Returns the alphabetic characters and digits of the parameter value.

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

getDigits($key, $default = '', $deep = false)   X-Ref
Returns the digits of the parameter value.

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

getInt($key, $default = 0, $deep = false)   X-Ref
Returns the parameter value converted to integer.

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

getBoolean($key, $default = false, $deep = false)   X-Ref
Returns the parameter value converted to boolean.

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

filter($key, $default = null, $filter = FILTER_DEFAULT, $options = array()   X-Ref
Filter key.

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

getIterator()   X-Ref
Returns an iterator for parameters.

return: \ArrayIterator An \ArrayIterator instance

count()   X-Ref
Returns the number of parameters.

return: int The number of parameters



Generated: Wed Nov 11 20:33:01 2020 Cross-referenced by PHPXref 0.7.1