Класс yii\web\UploadedFile
| Наследование | yii\web\UploadedFile » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/web/UploadedFile.php |
UploadedFile представляет информацию о загруженном файле.
Вы можете вызвать getInstance(), чтобы получить экземпляр загруженного файла, а затем использовать saveAs(), чтобы сохранить его на сервере. Вы также можете получить другую информацию о файле, включая $name, $tempName, $type, $size и $error.
Для получения более подробной информации и инструкций по использованию UploadedFile, ознакомьтесь со статьёй руководства по обработке загрузок.
Общедоступные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $baseName | string | Исходное имя файла без расширения | yii\web\UploadedFile |
| $error | integer | Код ошибки, описывающий состояние загрузки файла. | yii\web\UploadedFile |
| $extension | string | Расширение файла | yii\web\UploadedFile |
| $hasError | boolean | Указывает, есть ли ошибка с загруженным файлом. Для подробной информации об коде ошибки, см. $error. | yii\web\UploadedFile |
| $name | string | Исходное имя загружаемого файла | yii\web\UploadedFile |
| $size | integer | Фактический размер загруженного файла в байтах | yii\web\UploadedFile |
| $tempName | string | Путь к загруженному файлу на сервере. Обратите внимание, что это временный файл, который будет автоматически удален PHP после обработки текущего запроса. | yii\web\UploadedFile |
| $type | string | MIME-тип загруженного файла (например, "image/gif"). Поскольку этот MIME-тип не проверяется на стороне сервера, не полагайтесь на это значение. Вместо этого используйте yii\helpers\FileHelper::getMimeType() для определения точного MIME-типа. | yii\web\UploadedFile |
Общедоступные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает метод с указанным именем, который не является методом класса. | yii\base\Object |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, задано ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __toString() | Вывод в строковом формате. | yii\web\UploadedFile |
| __unset() | Устанавливает свойство объекта в null. | yii\base\Object |
| canGetProperty() | Возвращает значение, указывающее, можно ли прочитать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное имя этого класса. | yii\base\Object |
| getBaseName() | yii\web\UploadedFile | |
| getExtension() | yii\web\UploadedFile | |
| getHasError() | yii\web\UploadedFile | |
| getInstance() | Возвращает загруженный файл для заданного атрибута модели. | yii\web\UploadedFile |
| getInstanceByName() | Возвращает загруженный файл в соответствии с заданным именем входного файла. | yii\web\UploadedFile |
| getInstances() | Возвращает все загруженные файлы для заданного атрибута модели. | yii\web\UploadedFile |
| getInstancesByName() | Возвращает массив загруженных файлов, соответствующих указанному имени входного файла. | yii\web\UploadedFile |
| hasMethod() | Возвращает значение, указывающее, определен ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\base\Object |
| reset() | Очищает загруженные экземпляры UploadedFile. | yii\web\UploadedFile |
| saveAs() | Сохраняет загруженный файл. | yii\web\UploadedFile |
Подробное описание свойств
$baseName общедоступное только для чтения свойство
Исходное имя файла без расширения
public string getBaseName ( )
$error общедоступное свойство
Код ошибки, описывающий состояние загрузки файла.
См. также http://www.php.net/manual/en/features.file-upload.errors.php.
public integer $error = null
$extension общедоступное только для чтения свойство
Расширение файла
public string getExtension ( )
$hasError общедоступное только для чтения свойство
Указывает, есть ли ошибка с загруженным файлом. Для подробной информации об коде ошибки, см. $error.
public boolean getHasError ( )
$name общедоступное свойство
Исходное имя загружаемого файла
public string $name = null
$size общедоступное свойство
Фактический размер загруженного файла в байтах
public integer $size = null
$tempName общедоступное свойство
Путь к загруженному файлу на сервере. Обратите внимание, что это временный файл, который будет автоматически удален PHP после обработки текущего запроса.
public string $tempName = null
$type общедоступное свойство
MIME-тип загруженного файла (например, "image/gif"). Поскольку этот MIME-тип не проверяется на стороне сервера, не полагайтесь на это значение. Вместо этого используйте yii\helpers\FileHelper::getMimeType() для определения точного MIME-типа.
public string $type = null
Подробное описание методов
__toString() общедоступный метод
Вывод строки.
Это магический метод PHP, который возвращает строковое представление объекта. Здесь реализация возвращает имя загруженного файла.
| общедоступный строка __toString ( ) | ||
|---|---|---|
| возвращает | строка |
Строковое представление объекта |
getBaseName() общедоступный метод
| общедоступный строка getBaseName ( ) | ||
|---|---|---|
| возвращает | строка |
Исходное имя файла без пути |
getExtension() общедоступный метод
| общедоступный строка getExtension ( ) | ||
|---|---|---|
| возвращает | строка |
Расширение файла |
getHasError() общедоступный метод
| общедоступный логическое значение getHasError ( ) | ||
|---|---|---|
| возвращает | логическое значение |
Есть ли ошибка с загруженным файлом. Обратитесь к $error для получения подробной информации об коде ошибки. |
getInstance() общедоступный статический метод
Возвращает загруженный файл для заданного атрибута модели.
Файл должен быть загружен с помощью yii\widgets\ActiveField::fileInput().
См. также getInstanceByName().
| общедоступный статический yii\web\UploadedFile getInstance ( $model, $attribute ) | ||
|---|---|---|
| $model | yii\base\Model |
Модель данных |
| $attribute | строка |
Имя атрибута. Имя атрибута может содержать индексы массива. Например, '[1]file' для загрузки табличных файлов; и 'file[1]' для элемента в массиве файлов. |
| возвращает | yii\web\UploadedFile |
Экземпляр загруженного файла. Null возвращается, если для указанного атрибута модели не загружен файл. |
getInstanceByName() общедоступный статический метод
Возвращает загруженный файл по заданному имени поля ввода файла.
Имя может быть обычной строкой или строкой, похожей на элемент массива (например, 'Post[imageFile]', или 'Post[0][imageFile]').
| общедоступный статический null|yii\web\UploadedFile getInstanceByName ( $name ) | ||
|---|---|---|
| $name | строка |
Имя поля ввода файла. |
| возвращает | null|yii\web\UploadedFile |
Экземпляр загруженного файла. Null возвращается, если для указанного имени не загружен файл. |
getInstances() общедоступный статический метод
Возвращает все загруженные файлы для указанного атрибута модели.
| общедоступный статический yii\web\UploadedFile[] getInstances ( $model, $attribute ) | ||
|---|---|---|
| $model | yii\base\Model |
Модель данных |
| $attribute | строка |
Имя атрибута. Имя атрибута может содержать индексы массива для загрузки табличных файлов, например, '[1]file'. |
| возвращает | yii\web\UploadedFile[] |
Массив объектов UploadedFile. Пустой массив возвращается, если для данного атрибута не найден доступный файл. |
getInstancesByName() общедоступный статический метод
Возвращает массив загруженных файлов, соответствующих указанному имени поля ввода файла.
Это в основном используется, когда несколько файлов были загружены и сохранены как 'files[0]', 'files[1]', 'files[n]'..., и вы можете получить их все, передав 'files' в качестве имени.
| общедоступный статический yii\web\UploadedFile[] getInstancesByName ( $name ) | ||
|---|---|---|
| $name | строка |
Имя массива файлов |
| возвращает | yii\web\UploadedFile[] |
Массив объектов UploadedFile. Пустой массив возвращается, если подходящая загрузка не найдена. Обратите внимание, что этот массив будет содержать все файлы из всех подмассивов, независимо от их вложенности. |
reset() общедоступный статический метод
Очищает загруженные экземпляры UploadedFile.
Этот метод в основном используется скриптами тестов для подготовки фикстуры.
| общедоступный статический void reset ( ) |
|---|
saveAs() общедоступный метод
Сохраняет загруженный файл.
Обратите внимание, что этот метод использует метод php move_uploaded_file(). Если целевой файл $file уже существует, он будет перезаписан.
См. также $error.
| общедоступный логическое значение saveAs ( $file, $deleteTempFile = true ) | ||
|---|---|---|
| $file | строка |
Путь к файлу для сохранения загруженного файла |
| $deleteTempFile | логическое значение |
Удалить временный файл после сохранения. Если true, вы не сможете повторно сохранить загруженный файл в текущем запросе. |
| возвращает | логическое значение |
True, если файл сохранен успешно |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-web-uploadedfile.html
