UploadedFile

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

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

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

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

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

Параметры

string	$path	Путь к файлу
string	$originalName	Исходное имя файла
string	$mimeType	Тип файла, предоставленный PHP
int	$size	Размер файла
int	$error	Код ошибки загрузки (один из констант PHP UPLOAD_ERR_XXX)
bool	$test	Включен ли тестовый режим

Исключения

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()

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

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

bool	True, если файл был загружен с помощью HTTP и не произошло ошибок.

static int getMaxFilesize()

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

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

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

string getErrorMessage()

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

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

string

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