Spec-Zone.ru › Symfony 4.1

FileBag

class FileBag extends ParameterBag

FileBag — контейнер для загруженных файлов.

Свойства

protected $parameters Хранилище параметров. из ParameterBag

Методы

__construct(array $parameters = array())
array all()

Возвращает параметры.

из ParameterBag
array keys()

Возвращает ключи параметров.

из ParameterBag
replace(array $files = array())

Заменяет текущие параметры новым набором.

add(array $files = array())

Добавляет параметры.

mixed get(string $key, mixed $default = null)

Возвращает параметр по имени.

из ParameterBag
set(string $key, mixed $value)

Устанавливает параметр по имени.

bool has(string $key)

Возвращает true, если параметр определён.

из ParameterBag
remove(string $key)

Удаляет параметр.

из ParameterBag
string getAlpha(string $key, string $default = '')

Возвращает буквенные символы значения параметра.

из ParameterBag
string getAlnum(string $key, string $default = '')

Возвращает буквенные символы и цифры значения параметра.

из ParameterBag
string getDigits(string $key, string $default = '')

Возвращает цифры значения параметра.

из ParameterBag
int getInt(string $key, int $default = 0)

Возвращает значение параметра, преобразованное к целому числу.

из ParameterBag
bool getBoolean(string $key, mixed $default = false)

Возвращает значение параметра, преобразованное к булевому значению.

из ParameterBag
mixed filter(string $key, mixed $default = null, int $filter = FILTER_DEFAULT, mixed $options = array())

Фильтрация ключа.

из ParameterBag
ArrayIterator getIterator()

Возвращает итератор для параметров.

из ParameterBag
int count()

Возвращает количество параметров.

из ParameterBag
UploadedFile[]|UploadedFile|null convertFileInformation(array|UploadedFile $file)

Преобразует информацию о загруженных файлах в объекты UploadedFile.

array fixPhpFilesArray($data)

Исправляет повреждённый массив PHP $_FILES.

Подробное описание

__construct(array $parameters = array())

Параметры

array $parameters Массив параметров

array all()

Возвращает параметры.

Значение результата

array Массив параметров

array keys()

Возвращает ключи параметров.

Значение результата

array Массив ключей параметров

replace(array $files = array())

Заменяет текущие параметры новым набором.

Параметры

array $files

add(array $files = array())

Добавляет параметры.

Параметры

array $files

mixed get(string $key, mixed $default = null)

Возвращает параметр по имени.

Параметры

string $key Ключ
mixed $default Значение по умолчанию, если ключ параметра не существует

Значение результата

mixed

set(string $key, mixed $value)

Устанавливает параметр по имени.

Параметры

string $key Ключ
mixed $value Значение

bool has(string $key)

Возвращает true, если параметр определен.

Параметры

string $key Ключ

Значение результата

bool true, если параметр существует, иначе false

remove(string $key)

Удаляет параметр.

Параметры

string $key Ключ

string getAlpha(string $key, string $default = '')

Возвращает буквенные символы значения параметра.

Параметры

string $key Ключ параметра
string $default Значение по умолчанию, если ключ параметра не существует

Значение результата

string Отфильтрованное значение

string getAlnum(string $key, string $default = '')

Возвращает буквенные и цифровые символы значения параметра.

Параметры

string $key Ключ параметра
string $default Значение по умолчанию, если ключ параметра не существует

Значение результата

string Отфильтрованное значение

string getDigits(string $key, string $default = '')

Возвращает цифровые символы значения параметра.

Параметры

string $key Ключ параметра
string $default Значение по умолчанию, если ключ параметра не существует

Значение результата

string Отфильтрованное значение

int getInt(string $key, int $default = 0)

Возвращает значение параметра, преобразованное в целое число.

Параметры

string $key Ключ параметра
int $default Значение по умолчанию, если ключ параметра не существует

Значение результата

int Отфильтрованное значение

bool getBoolean(string $key, mixed $default = false)

Возвращает значение параметра, преобразованное в булево значение.

Параметры

string $key Ключ параметра
mixed $default Значение по умолчанию, если ключ параметра не существует

Значение результата

bool Отфильтрованное значение

mixed filter(string $key, mixed $default = null, int $filter = FILTER_DEFAULT, mixed $options = array())

Фильтрация ключа.

Параметры

string $key Ключ
mixed $default По умолчанию = null
int $filter Константа FILTER_*
mixed $options Параметры фильтра

Значение результата

mixed

См. также

http://php.net/manual/en/function.filter-var.php

ArrayIterator getIterator()

Возвращает итератор для параметров.

Значение результата

ArrayIterator Объект \ArrayIterator

int count()

Возвращает количество параметров.

Значение результата

int Количество параметров

protected UploadedFile[]|UploadedFile|null convertFileInformation(array|UploadedFile $file)

Преобразует загруженные файлы в объекты UploadedFile.

Параметры

array|UploadedFile $file (Многомерный) массив информации о загруженном файле

Значение результата

UploadedFile[]|UploadedFile|null (Многомерный) массив объектов UploadedFile

protected array fixPhpFilesArray($data)

Исправляет неправильный массив PHP $_FILES.

В PHP есть ошибка, из-за которой формат массива $_FILES отличается в зависимости от того, имели ли поля загруженных файлов обычные имена полей или имена полей в стиле массива ("обычное" или "родитель[дочерний]").

Этот метод исправляет массив, чтобы он выглядел как обычный массив $_FILES.

Безопасно передавать уже преобразованный массив; в этом случае метод просто возвращает исходный массив без изменений.

Параметры

$data

Значение результата

array

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/HttpFoundation/FileBag.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API