Spec-Zone.ru › Laravel 10

Файл

класс File расширяет UploadedFile (View source)

Черты

FileHelpers
Macroable

Свойства

protected string $hashName

Кэшированная копия хеш-имени файла.

из FileHelpers
static protected array $macros

Зарегистрированные строковые макросы.

из Macroable
string $name

Имя файла.

resource $tempFile

Временный файловый ресурс.

int $sizeToReport

Размер для отображения.

string|null $mimeTypeToReport

MIME-тип для отображения.

Методы

string path()

Получить полный путь к файлу.

из FileHelpers
string extension()

Получить расширение файла.

из FileHelpers
string hashName(string|null $path = null)

Получить имя файла.

из FileHelpers
array|null dimensions()

Получить размеры изображения (если применимо).

из FileHelpers
static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательский макрос.

из Macroable
static void mixin(object $mixin, bool $replace = true)

Смешать другой объект в класс.

из Macroable
static bool hasMacro(string $name)

Проверить, зарегистрирован ли макрос.

из Macroable
static void flushMacros()

Очистить существующие макросы.

из Macroable
static mixed __callStatic(string $method, array $parameters)

Динамически обрабатывать вызовы класса.

из Macroable
mixed __call(string $method, array $parameters)

Динамически обрабатывать вызовы класса.

из Macroable
static FileFactory fake()

Начать создание нового фиктивного файла.

из UploadedFile
string|false store(string $path = '', array|string $options = [])

Сохранить загруженный файл на файловой системе.

из UploadedFile
string|false storePublicly(string $path = '', array|string $options = [])

Сохранить загруженный файл на файловой системе с общедоступным доступом.

из UploadedFile
string|false storePubliclyAs(string $path, string $name = null, array|string $options = [])

Сохранить загруженный файл на файловой системе с общедоступным доступом.

из UploadedFile
string|false storeAs(string $path, string|array $name = null, array|string $options = [])

Сохранить загруженный файл на файловой системе.

из UploadedFile
false|string get()

Получить содержимое загруженного файла.

из UploadedFile
string clientExtension()

Получить расширение файла, предоставленное клиентом.

из UploadedFile
static UploadedFile createFromBase(UploadedFile $file, bool $test = false)

Создать новый экземпляр файла из базового экземпляра.

из UploadedFile
array parseOptions(array|string $options)

Разбор и форматирование заданных параметров.

из UploadedFile
void __construct(string $name, resource $tempFile)

Создать новый экземпляр файла.

static File create(string $name, string|int $kilobytes = 0)

Создать новый фиктивный файл.

static File createWithContent(string $name, string $content)

Создать новый фиктивный файл с содержимым.

static File image(string $name, int $width = 10, int $height = 10)

Создать новое фиктивное изображение.

$this size(int $kilobytes)

Установить размер файла в килобайтах.

int getSize()

Получить размер файла.

$this mimeType(string $mimeType)

Установить MIME-тип для файла.

string getMimeType()

Получить MIME-тип файла.

string tempFilePath()

Получить путь к временному файлу.

Подробности

string path()

Получить полный путь к файлу.

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

string

string extension()

Получить расширение файла.

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

string

строка hashName(строка|null $path = null)

Получить имя файла.

Параметры

строка|null $path

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

строка

массив|null dimensions()

Получить размеры изображения (если применимо).

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

массив|null

статический пустое значение macro(строка $name, объект|вызываемый $macro)

Зарегистрировать пользовательскую макрокоманду.

Параметры

строка $name
объект|вызываемый $macro

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

пустое значение

статический пустое значение mixin(объект $mixin, bool $replace = true)

Добавить другой объект в класс.

Параметры

объект $mixin
bool $replace

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

пустое значение

Исключения

ReflectionException

статический bool hasMacro(строка $name)

Проверяет, зарегистрирована ли макрокоманда.

Параметры

строка $name

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

bool

статический пустое значение flushMacros()

Очистить существующие макрокоманды.

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

пустое значение

статический смешанный __callStatic(строка $method, массив $parameters)

Динамически обрабатывать вызовы класса.

Параметры

строка $method
массив $parameters

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

смешанный

Исключения

BadMethodCallException

смешанный __call(строка $method, массив $parameters)

Динамически обрабатывать вызовы класса.

Параметры

строка $method
массив $parameters

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

смешанный

Исключения

BadMethodCallException

статический FileFactory fake()

Начать создание нового файла-эмулятора.

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

FileFactory

строка|ложь store(строка $path = '', массив|строка $options = [])

Сохранить загруженный файл на диске файловой системы.

Параметры

строка $path
массив|строка $options

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

строка|ложь

строка|ложь storePublicly(строка $path = '', массив|строка $options = [])

Сохранить загруженный файл на диске файловой системы с общедоступностью.

Параметры

строка $path
массив|строка $options

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

строка|ложь

строка|ложь storePubliclyAs(строка $path, строка $name = null, массив|строка $options = [])

Сохранить загруженный файл на диске файловой системы с общедоступностью.

Параметры

строка $path
строка $name
массив|строка $options

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

строка|ложь

строка|ложь storeAs(строка $path, строка|массив $name = null, массив|строка $options = [])

Сохранить загруженный файл на диске файловой системы.

Параметры

строка $path
строка|массив $name
массив|строка $options

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

строка|ложь

ложь|строка get()

Получить содержимое загруженного файла.

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

ложь|строка

Исключения

FileNotFoundException

строка clientExtension()

Получить расширение файла, предоставленное клиентом.

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

строка

статический UploadedFile createFromBase(UploadedFile $file, bool $test = false)

Создать новый экземпляр файла из базового экземпляра.

Параметры

UploadedFile $file
bool $test

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

UploadedFile

защищенный массив parseOptions(массив|строка $options)

Обработать и отформатировать заданные параметры.

Параметры

массив|строка $options

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

массив

пустое значение __construct(строка $name, ресурс $tempFile)

Создать новый экземпляр файла.

Параметры

строка $name
ресурс $tempFile

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

пустое значение

статический File create(строка $name, строка|целое число $kilobytes = 0)

Создать новый эмулируемый файл.

Параметры

строка $name
строка|целое число $kilobytes

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

File

статический File createWithContent(строка $name, строка $content)

Создать новый эмулируемый файл с содержимым.

Параметры

строка $name
строка $content

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

File
END_OF_DOCUMENT_MARKER

static Файл image(string $name, int $width = 10, int $height = 10)

Создать новый фиктивный образ.

Параметры

string $name
int $width
int $height

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

Файл

$this size(int $kilobytes)

Установить «размер» файла в килобайтах.

Параметры

int $kilobytes

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

$this

int getSize()

Получить размер файла.

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

int

$this mimeType(string $mimeType)

Установить «тип MIME» для файла.

Параметры

string $mimeType

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

$this

string getMimeType()

Получить тип MIME файла.

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

string

protected string tempFilePath()

Получить путь к временному файлу.

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

string

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Http/Testing/File.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API