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.

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

Parameters

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

Exceptions

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

string|null guessExtension()

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

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

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

Return Value

string|null

Определенное расширение или null, если определить не удалось

See also

ExtensionGuesser
getMimeType()

string|null getMimeType()

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

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

Return Value

string|null

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

See also

MimeTypeGuesser

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

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

Parameters

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

Return Value

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

Exceptions

FileException

Если по какой-либо причине файл не удалось переместить

string|null getClientOriginalName()

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

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

Return Value

string|null

Исходное имя

string getClientOriginalExtension()

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

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

Return Value

string

Расширение

string|null getClientMimeType()

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

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

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

Return Value

string|null

Тип MIME

See also

getMimeType()

string|null guessClientExtension()

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

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

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

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

Return Value

string|null

Определенное расширение или null, если определить не удалось

See also

guessExtension()
getClientMimeType()

int|null getClientSize()

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

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

Return Value

int|null

Размер файла

int getError()

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

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

Return Value

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

bool isValid()

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

Return Value

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

static int getMaxFilesize()

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

Return Value

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

string getErrorMessage()

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

Return Value

string

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