FileBag is a container for HTTP headers.
@author Fabien Potencier <fabien@symfony.com> @author Bulat Shakirzyanov <mallluhuct@gmail.com>
@api
Expanded class hierarchy of FileBag
class FileBag extends ParameterBag {
private static $fileKeys = array(
'error',
'name',
'size',
'tmp_name',
'type',
);
/**
* Constructor.
*
* @param array $parameters An array of HTTP files
*
* @api
*/
public function __construct(array $parameters = array()) {
$this
->replace($parameters);
}
/**
* {@inheritdoc}
*
* @api
*/
public function replace(array $files = array()) {
$this->parameters = array();
$this
->add($files);
}
/**
* {@inheritdoc}
*
* @api
*/
public function set($key, $value) {
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));
}
/**
* {@inheritdoc}
*
* @api
*/
public function add(array $files = array()) {
foreach ($files as $key => $file) {
$this
->set($key, $file);
}
}
/**
* Converts uploaded files to UploadedFile instances.
*
* @param array|UploadedFile $file A (multi-dimensional) array of uploaded file information
*
* @return array A (multi-dimensional) array of UploadedFile instances
*/
protected function convertFileInformation($file) {
if ($file instanceof UploadedFile) {
return $file;
}
$file = $this
->fixPhpFilesArray($file);
if (is_array($file)) {
$keys = array_keys($file);
sort($keys);
if ($keys == self::$fileKeys) {
if (UPLOAD_ERR_NO_FILE == $file['error']) {
$file = null;
}
else {
$file = new UploadedFile($file['tmp_name'], $file['name'], $file['type'], $file['size'], $file['error']);
}
}
else {
$file = array_map(array(
$this,
'convertFileInformation',
), $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.
*
* @param array $data
*
* @return array
*/
protected function fixPhpFilesArray($data) {
if (!is_array($data)) {
return $data;
}
$keys = array_keys($data);
sort($keys);
if (self::$fileKeys != $keys || !isset($data['name']) || !is_array($data['name'])) {
return $data;
}
$files = $data;
foreach (self::$fileKeys as $k) {
unset($files[$k]);
}
foreach (array_keys($data['name']) as $key) {
$files[$key] = $this
->fixPhpFilesArray(array(
'error' => $data['error'][$key],
'name' => $data['name'][$key],
'type' => $data['type'][$key],
'tmp_name' => $data['tmp_name'][$key],
'size' => $data['size'][$key],
));
}
return $files;
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
FileBag:: |
private static | property | ||
FileBag:: |
protected | function | Converts uploaded files to UploadedFile instances. | |
FileBag:: |
protected | function | Fixes a malformed PHP $_FILES array. | |
ParameterBag:: |
protected | property | Parameter storage. | |
FileBag:: |
public | function |
Constructor. Overrides ParameterBag:: |
|
FileBag:: |
public | function |
@api Overrides ParameterBag:: |
|
FileBag:: |
public | function |
@api Overrides ParameterBag:: |
|
FileBag:: |
public | function |
@api Overrides ParameterBag:: |
|
ParameterBag:: |
public | function | Returns the parameters. | |
ParameterBag:: |
public | function | Returns the parameter keys. | |
ParameterBag:: |
public | function | Returns a parameter by name. | |
ParameterBag:: |
public | function | Returns true if the parameter is defined. | |
ParameterBag:: |
public | function | Removes a parameter. | |
ParameterBag:: |
public | function | Returns the alphabetic characters of the parameter value. | |
ParameterBag:: |
public | function | Returns the alphabetic characters and digits of the parameter value. | |
ParameterBag:: |
public | function | Returns the digits of the parameter value. | |
ParameterBag:: |
public | function | Returns the parameter value converted to integer. | |
ParameterBag:: |
public | function | Filter key. | |
ParameterBag:: |
public | function | Returns an iterator for parameters. | |
ParameterBag:: |
public | function | Returns the number of parameters. |