class FileBag
FileBag is a container for uploaded files.
@author Fabien Potencier <fabien@symfony.com> @author Bulat Shakirzyanov <mallluhuct@gmail.com>
Hierarchy
- class \Symfony\Component\HttpFoundation\ParameterBag implements \Symfony\Component\HttpFoundation\IteratorAggregate, \Symfony\Component\HttpFoundation\Countable
- class \Symfony\Component\HttpFoundation\FileBag extends \Symfony\Component\HttpFoundation\ParameterBag
Expanded class hierarchy of FileBag
1 file declares its use of FileBag
- FormBuilder.php in core/
lib/ Drupal/ Core/ Form/ FormBuilder.php
File
-
vendor/
symfony/ http-foundation/ FileBag.php, line 22
Namespace
Symfony\Component\HttpFoundationView source
class FileBag extends ParameterBag {
private const FILE_KEYS = [
'error',
'full_path',
'name',
'size',
'tmp_name',
'type',
];
/**
* @param array|UploadedFile[] $parameters An array of HTTP files
*/
public function __construct(array $parameters = []) {
$this->replace($parameters);
}
public function replace(array $files = []) : void {
$this->parameters = [];
$this->add($files);
}
public function set(string $key, mixed $value) : void {
if (!\is_array($value) && !$value instanceof UploadedFile) {
throw new \InvalidArgumentException('An uploaded file must be an array or an instance of UploadedFile.');
}
parent::set($key, $this->convertFileInformation($value));
}
public function add(array $files = []) : void {
foreach ($files as $key => $file) {
$this->set($key, $file);
}
}
/**
* Converts uploaded files to UploadedFile instances.
*
* @return UploadedFile[]|UploadedFile|null
*/
protected function convertFileInformation(array|UploadedFile $file) : array|UploadedFile|null {
if ($file instanceof UploadedFile) {
return $file;
}
$file = $this->fixPhpFilesArray($file);
$keys = array_keys($file + [
'full_path' => null,
]);
sort($keys);
if (self::FILE_KEYS === $keys) {
if (\UPLOAD_ERR_NO_FILE === $file['error']) {
$file = null;
}
else {
$file = new UploadedFile($file['tmp_name'], $file['full_path'] ?? $file['name'], $file['type'], $file['error'], false);
}
}
else {
$file = array_map(fn($v) => $v instanceof UploadedFile || \is_array($v) ? $this->convertFileInformation($v) : $v, $file);
if (array_is_list($file)) {
$file = array_filter($file);
}
}
return $file;
}
/**
* 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.
*/
protected function fixPhpFilesArray(array $data) : array {
$keys = array_keys($data + [
'full_path' => null,
]);
sort($keys);
if (self::FILE_KEYS !== $keys || !isset($data['name']) || !\is_array($data['name'])) {
return $data;
}
$files = $data;
foreach (self::FILE_KEYS as $k) {
unset($files[$k]);
}
foreach ($data['name'] as $key => $name) {
$files[$key] = $this->fixPhpFilesArray([
'error' => $data['error'][$key],
'name' => $name,
'type' => $data['type'][$key],
'tmp_name' => $data['tmp_name'][$key],
'size' => $data['size'][$key],
] + (isset($data['full_path'][$key]) ? [
'full_path' => $data['full_path'][$key],
] : []));
}
return $files;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
FileBag::add | public | function | Adds parameters. | Overrides ParameterBag::add | |
FileBag::convertFileInformation | protected | function | Converts uploaded files to UploadedFile instances. | ||
FileBag::FILE_KEYS | private | constant | |||
FileBag::fixPhpFilesArray | protected | function | Fixes a malformed PHP $_FILES array. | ||
FileBag::replace | public | function | Replaces the current parameters by a new set. | Overrides ParameterBag::replace | |
FileBag::set | public | function | Overrides ParameterBag::set | ||
FileBag::__construct | public | function | Overrides ParameterBag::__construct | ||
ParameterBag::all | public | function | Returns the parameters. | ||
ParameterBag::count | public | function | Returns the number of parameters. | ||
ParameterBag::filter | public | function | Filter key. | 1 | |
ParameterBag::get | public | function | 1 | ||
ParameterBag::getAlnum | public | function | Returns the alphabetic characters and digits of the parameter value. | ||
ParameterBag::getAlpha | public | function | Returns the alphabetic characters of the parameter value. | ||
ParameterBag::getBoolean | public | function | Returns the parameter value converted to boolean. | ||
ParameterBag::getDigits | public | function | Returns the digits of the parameter value. | ||
ParameterBag::getEnum | public | function | Returns the parameter value converted to an enum. | 1 | |
ParameterBag::getInt | public | function | Returns the parameter value converted to integer. | ||
ParameterBag::getIterator | public | function | Returns an iterator for parameters. | ||
ParameterBag::getString | public | function | Returns the parameter as string. | 1 | |
ParameterBag::has | public | function | Returns true if the parameter is defined. | ||
ParameterBag::keys | public | function | Returns the parameter keys. | ||
ParameterBag::remove | public | function | Removes a parameter. |