Documentation

FileBag extends ParameterBag
in package

FileBag is a container for uploaded files.

Tags
author

Fabien Potencier fabien@symfony.com

author

Bulat Shakirzyanov mallluhuct@gmail.com

Table of Contents

Constants

FILE_KEYS  = ['error', 'name', 'size', 'tmp_name', 'type']

Properties

$parameters  : mixed
Parameter storage.

Methods

__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
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
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

add()

Adds parameters.

public add([array<string|int, mixed> $files = [] ]) : mixed
Parameters
$files : array<string|int, mixed> = []

all()

Returns the parameters.

public all([string|null $key = null ]) : array<string|int, mixed>
Parameters
$key : string|null = null

The name of the parameter to return or null to get them all

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
$filter : int = FILTER_DEFAULT

FILTER_* constant

$options : mixed = []
Tags
see
https://php.net/filter-var

get()

public get(string $key[, mixed $default = null ]) : mixed
Parameters
$key : string
$default : mixed = null

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 = 0 ]) : int
Parameters
$key : string
$default : int = 0
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

replace()

Replaces the current parameters by a new set.

public replace([array<string|int, mixed> $files = [] ]) : mixed
Parameters
$files : array<string|int, mixed> = []

set()

public set(string $key, mixed $value) : mixed
Parameters
$key : string
$value : mixed

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>
Return values
array<string|int, mixed>

        
On this page

Search results