FileBag
extends ParameterBag
in package
FileBag is a container for uploaded files.
Tags
Table of Contents
- FILE_KEYS = ['error', 'name', 'size', 'tmp_name', 'type']
- $parameters : mixed
- Parameter storage.
- __construct() : mixed
- add() : mixed
- Adds parameters.
- all() : array<string|int, mixed>
- Returns the parameters.
- count() : int
- Returns the number of parameters.
- filter() : mixed
- Filter key.
- get() : mixed
- Returns a parameter by name.
- getAlnum() : string
- Returns the alphabetic characters and digits of the parameter value.
- getAlpha() : string
- Returns the alphabetic characters of the parameter value.
- getBoolean() : bool
- Returns the parameter value converted to boolean.
- getDigits() : string
- Returns the digits of the parameter value.
- getInt() : int
- Returns the parameter value converted to integer.
- getIterator() : ArrayIterator<string, mixed>
- Returns an iterator for parameters.
- has() : bool
- Returns true if the parameter is defined.
- keys() : array<string|int, mixed>
- Returns the parameter keys.
- remove() : mixed
- Removes a parameter.
- replace() : mixed
- Replaces the current parameters by a new set.
- set() : mixed
- Sets a parameter by name.
- convertFileInformation() : array<string|int, UploadedFile>|UploadedFile|null
- Converts uploaded files to UploadedFile instances.
- fixPhpFilesArray() : array<string|int, mixed>
- Fixes a malformed PHP $_FILES array.
Constants
FILE_KEYS
private
mixed
FILE_KEYS
= ['error', 'name', 'size', 'tmp_name', 'type']
Properties
$parameters
Parameter storage.
protected
mixed
$parameters
Methods
__construct()
public
__construct([array<string|int, mixed>|array<string|int, UploadedFile> $parameters = [] ]) : mixed
Parameters
- $parameters : array<string|int, mixed>|array<string|int, UploadedFile> = []
-
An array of HTTP files
Return values
mixed —add()
Adds parameters.
public
add([array<string|int, mixed> $files = [] ]) : mixed
Parameters
- $files : array<string|int, mixed> = []
Return values
mixed —all()
Returns the parameters.
public
all() : array<string|int, mixed>
Return values
array<string|int, mixed> —count()
Returns the number of parameters.
public
count() : int
Return values
int —filter()
Filter key.
public
filter(string $key[, mixed $default = null ][, int $filter = FILTER_DEFAULT ][, mixed $options = [] ]) : mixed
Parameters
- $key : string
- $default : mixed = null
-
Default = null
- $filter : int = FILTER_DEFAULT
-
FILTER_* constant
- $options : mixed = []
-
Filter options
Tags
Return values
mixed —get()
Returns a parameter by name.
public
get(string $key[, mixed $default = null ]) : mixed
Parameters
- $key : string
- $default : mixed = null
-
The default value if the parameter key does not exist
Return values
mixed —getAlnum()
Returns the alphabetic characters and digits of the parameter value.
public
getAlnum(string $key[, string $default = '' ]) : string
Parameters
- $key : string
- $default : string = ''
Return values
string —getAlpha()
Returns the alphabetic characters of the parameter value.
public
getAlpha(string $key[, string $default = '' ]) : string
Parameters
- $key : string
- $default : string = ''
Return values
string —getBoolean()
Returns the parameter value converted to boolean.
public
getBoolean(string $key[, bool $default = false ]) : bool
Parameters
- $key : string
- $default : bool = false
Return values
bool —getDigits()
Returns the digits of the parameter value.
public
getDigits(string $key[, string $default = '' ]) : string
Parameters
- $key : string
- $default : string = ''
Return values
string —getInt()
Returns the parameter value converted to integer.
public
getInt(string $key, int $default) : int
Parameters
- $key : string
- $default : int
Return values
int —getIterator()
Returns an iterator for parameters.
public
getIterator() : ArrayIterator<string, mixed>
Return values
ArrayIterator<string, mixed> —has()
Returns true if the parameter is defined.
public
has(string $key) : bool
Parameters
- $key : string
Return values
bool —keys()
Returns the parameter keys.
public
keys() : array<string|int, mixed>
Return values
array<string|int, mixed> —remove()
Removes a parameter.
public
remove(string $key) : mixed
Parameters
- $key : string
Return values
mixed —replace()
Replaces the current parameters by a new set.
public
replace([array<string|int, mixed> $files = [] ]) : mixed
Parameters
- $files : array<string|int, mixed> = []
Return values
mixed —set()
Sets a parameter by name.
public
set(string $key, mixed $value) : mixed
Parameters
- $key : string
- $value : mixed
-
The value
Return values
mixed —convertFileInformation()
Converts uploaded files to UploadedFile instances.
protected
convertFileInformation(array<string|int, mixed>|UploadedFile $file) : array<string|int, UploadedFile>|UploadedFile|null
Parameters
- $file : array<string|int, mixed>|UploadedFile
-
A (multi-dimensional) array of uploaded file information
Return values
array<string|int, UploadedFile>|UploadedFile|null —fixPhpFilesArray()
Fixes a malformed PHP $_FILES array.
protected
fixPhpFilesArray(array<string|int, mixed> $data) : array<string|int, mixed>
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 : array<string|int, mixed>