FileBag
class FileBag extends ParameterBag
FileBag is a container for uploaded files.
Properties
| protected | $parameters | Parameter storage. | from ParameterBag |
Methods
| __construct(array $parameters = array()) | ||
| 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) 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 = '') Returns the alphabetic characters of the parameter value. |
from ParameterBag |
| string | getAlnum(string $key, string $default = '') Returns the alphabetic characters and digits of the parameter value. |
from ParameterBag |
| string | getDigits(string $key, string $default = '') Returns the digits of the parameter value. |
from ParameterBag |
| int | getInt(string $key, int $default = 0) Returns the parameter value converted to integer. |
from ParameterBag |
| bool | getBoolean(string $key, mixed $default = false) Returns the parameter value converted to boolean. |
from ParameterBag |
| mixed | filter(string $key, mixed $default = null, int $filter = FILTER_DEFAULT, mixed $options = array()) Filter key. |
from ParameterBag |
| ArrayIterator | getIterator() Returns an iterator for parameters. |
from ParameterBag |
| int | count() Returns the number of parameters. |
from ParameterBag |
| UploadedFile[]|UploadedFile|null | convertFileInformation(array|UploadedFile $file) Converts uploaded files to UploadedFile instances. |
|
| array | fixPhpFilesArray($data) Fixes a malformed PHP $_FILES array. |
Details
__construct(array $parameters = array())
Parameters
| array | $parameters | An array of parameters |
array all()
Returns the parameters.
Return Value
| array | An array of parameters |
array keys()
Returns the parameter keys.
Return Value
| array | An array of parameter keys |
replace(array $files = array())
Replaces the current parameters by a new set.
Parameters
| array | $files |
add(array $files = array())
Adds parameters.
Parameters
| array | $files |
mixed get(string $key, mixed $default = null)
Returns a parameter by name.
Parameters
| string | $key | The key |
| mixed | $default | The default value if the parameter key does not exist |
Return Value
| mixed |
set(string $key, mixed $value)
Sets a parameter by name.
Parameters
| string | $key | The key |
| mixed | $value | The value |
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 |
remove(string $key)
Removes a parameter.
Parameters
| string | $key | The key |
string getAlpha(string $key, string $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 |
Return Value
| string | The filtered value |
string getAlnum(string $key, string $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 |
Return Value
| string | The filtered value |
string getDigits(string $key, string $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 |
Return Value
| string | The filtered value |
int getInt(string $key, int $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 |
Return Value
| int | The filtered value |
bool getBoolean(string $key, mixed $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 |
Return Value
| bool | The filtered value |
mixed filter(string $key, mixed $default = null, int $filter = FILTER_DEFAULT, mixed $options = array())
Filter key.
Parameters
| string | $key | Key |
| mixed | $default | Default = null |
| int | $filter | FILTER_* constant |
| mixed | $options | Filter options |
Return Value
| mixed |
See also
ArrayIterator getIterator()
Returns an iterator for parameters.
Return Value
| ArrayIterator | An \ArrayIterator instance |
int count()
Returns the number of parameters.
Return Value
| int | The number of parameters |
protected UploadedFile[]|UploadedFile|null convertFileInformation(array|UploadedFile $file)
Converts uploaded files to UploadedFile instances.
Parameters
| array|UploadedFile | $file | A (multi-dimensional) array of uploaded file information |
Return Value
| UploadedFile[]|UploadedFile|null | A (multi-dimensional) array of UploadedFile instances |
protected array fixPhpFilesArray($data)
Fixes a malformed PHP $_FILES array.
PHP has a bug that the format of the $_FILES array differs, depending on whether the uploaded file fields had normal field names or array-like field names ("normal" vs. "parent[child]").
This method fixes the array to look like the "normal" $_FILES array.
It's safe to pass an already converted array, in which case this method just returns the original array unmodified.
Parameters
| $data |
Return Value
| array |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/HttpFoundation/FileBag.html