UploadedFile

__construct(string $path, string $originalName, string|null $mimeType = null, int|null $size = null, int|null $error = null, bool $test = false)

Принимает информацию о загруженном файле, предоставленную глобальным PHP массивом $_FILES.

Объект файла создаётся только при успешной загрузке (т.е. когда метод isValid() возвращает true). В противном случае единственными методами, которые можно вызвать на экземпляре UploadedFile, являются:

• getClientOriginalName,
• getClientMimeType,
• isValid,
• getError.

Вызов любого другого метода на недопустимом экземпляре приведёт к непредсказуемым результатам.

Параметры

string	$path	Путь к файлу
string	$originalName	Исходное имя загруженного файла
string|null	$mimeType	Тип файла, предоставленный PHP; по умолчанию null, что соответствует application/octet-stream
int|null	$size	Размер файла, предоставленный загружающим приложением
int|null	$error	Код ошибки загрузки (один из констант PHP UPLOAD_ERR_XXX); по умолчанию UPLOAD_ERR_OK
bool	$test	Включён ли тестовый режим. В тестовом режиме используются локальные файлы, поэтому код не должен принудительно осуществлять HTTP-загрузку.

Исключения

FileException	Если file_uploads отключен
FileNotFoundException	Если файл не найден

string|null guessExtension()

Возвращает расширение файла на основе MIME-типа.

Если MIME-тип неизвестен, возвращает null.

Этот метод использует MIME-тип, полученный методом getMimeType(), для определения расширения файла.

Возвращаемое значение

string|null

Определённое расширение или null, если оно не может быть определено

См. также

ExtensionGuesser
getMimeType()

string|null getMimeType()

Возвращает MIME-тип файла.

MIME-тип определяется с помощью экземпляра MimeTypeGuesser, использующего finfo(), mime_content_type() и системную утилиту "file" (в этом порядке), в зависимости от доступности каждого из них.

Возвращаемое значение

string|null

Определённый MIME-тип (например, "application/pdf")

См. также

MimeTypeGuesser

File move(string $directory, string $name = null)

Перемещает файл в новое местоположение.

Параметры

string	$directory	Папка назначения
string	$name	Новое имя файла

Возвращаемое значение

File	Объект File, представляющий новый файл

Исключения

FileException

Если файл по каким-либо причинам не может быть перемещён

string|null getClientOriginalName()

Возвращает исходное имя файла.

Извлекается из запроса, с которого был загружен файл. Поэтому не следует считать это значение безопасным.

Возвращаемое значение

string|null

Исходное имя

string getClientOriginalExtension()

Возвращает исходное расширение файла.

Извлекается из исходного имени загруженного файла. Поэтому не следует считать это значение безопасным.

Возвращаемое значение

string

Расширение

string|null getClientMimeType()

Возвращает MIME-тип файла.

MIME-тип клиента извлекается из запроса, с которого был загружен файл, поэтому не следует считать его безопасным.

Для получения надёжного MIME-типа используйте getMimeType() (который определяет MIME-тип на основе содержимого файла).

Возвращаемое значение

string|null

MIME-тип

См. также

getMimeType()

string|null guessClientExtension()

Возвращает расширение на основе MIME-типа клиента.

Если MIME-тип неизвестен, возвращает null.

Этот метод использует MIME-тип, полученный методом getClientMimeType(), для определения расширения файла. Поэтому расширение, возвращаемое этим методом, нельзя считать надёжным.

Для получения надёжного расширения используйте guessExtension() (который определяет расширение на основе предполагаемого MIME-типа файла).

Возвращаемое значение

string|null

Определённое расширение или null, если оно не может быть определено

См. также

guessExtension()
getClientMimeType()

int|null getClientSize()

Возвращает размер файла.

Извлекается из запроса, с которого был загружен файл. Поэтому не следует считать это значение безопасным.

Возвращаемое значение

int|null

Размер файла

int getError()

Возвращает код ошибки загрузки.

Если загрузка прошла успешно, возвращается константа UPLOAD_ERR_OK. В противном случае возвращается одна из других констант UPLOAD_ERR_XXX.

Возвращаемое значение

int	Код ошибки загрузки

bool isValid()

Возвращает true, если файл был загружен успешно.

Возвращаемое значение

bool	True, если файл был загружен через HTTP и ошибок не возникло

static int getMaxFilesize()

Возвращает максимальный размер загружаемого файла, заданный в php.ini.

Возвращаемое значение

int	Максимальный размер загружаемого файла в байтах

string getErrorMessage()

Возвращает информативное сообщение об ошибке загрузки.

Возвращаемое значение

string

Сообщение об ошибке, соответствующее указанному коду ошибки