W3cubDocs

/Symfony 3.0

Symfony\Component\HttpFoundation\FileBag

class FileBag extends ParameterBag

FileBag is a container for uploaded files.

Methods

__construct(array $parameters = array())

Constructor.
array all()

Returns the parameters.

 from ParameterBag
array keys()

Returns the parameter keys.

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

Replaces the current parameters by a new set.
add(array $files = array())

Adds parameters.
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.
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

Details

public __construct(array $parameters = array())

Constructor.

Parameters

array $parameters An array of HTTP files

public array all()

Returns the parameters.

Return Value

array An array of parameters

public array keys()

Returns the parameter keys.

Return Value

array An array of parameter keys

public replace(array $files = array())

Replaces the current parameters by a new set.

Parameters

array $files

public add(array $files = array())

Adds parameters.

Parameters

array $files

public 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

public set(string $key, mixed $value)

Sets a parameter by name.

Parameters

string $key The key
mixed $value The value

public 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

public remove(string $key)

Removes a parameter.

Parameters

string $key The key

public 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

public 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

public 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

public 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

public 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

public 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

public ArrayIterator getIterator()

Returns an iterator for parameters.

Return Value

ArrayIterator An \ArrayIterator instance

public int count()

Returns the number of parameters.

Return Value

int The number of parameters

© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/HttpFoundation/FileBag.html