UploadedFile

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

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

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

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

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

Параметры

string	$path	Путь к файлу
string	$originalName	Исходное имя загруженного файла
string	$mimeType	Тип файла, предоставленный PHP; по умолчанию application/octet-stream
int	$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

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

protected getTargetFile($directory, $name = null)

Параметры

	$directory
	$name

protected string getName(string $name)

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

Параметры

string

$name

Новое имя файла

Значение, возвращаемое функцией

string

содержащий

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

^deprecated

since Symfony 4.1, используйте getSize() вместо этого.

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

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

Значение, возвращаемое функцией

int|null

Размер файла

int getError()

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

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

Значение, возвращаемое функцией

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

bool isValid()

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

Значение, возвращаемое функцией

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

static int getMaxFilesize()

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

Значение, возвращаемое функцией

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

string getErrorMessage()

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

Значение, возвращаемое функцией

string

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