Spec-Zone.ru › Laravel 9

Файл

класс Файл расширяет UploadedFile (Просмотреть исходный код)

Трейты

FileHelpers
Macroable

Свойства

защищённая строка $hashName

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

 из FileHelpers
статическая защищённая массив $macros

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

 из Macroable
строка $name

Имя файла.
ресурс $tempFile

Временный ресурс файла.
целое число $sizeToReport

Отчёт о размере.
строка|null $mimeTypeToReport

Отчёт о MIME-типе.

Методы

string path()

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

 из FileHelpers
string extension()

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

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

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

 из 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, array|string $options = [])

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

 из UploadedFile
string|false storeAs(string $path, string $name, 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

string hashName(string|null $path = null)

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

Параметры

string|null $path

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

string

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

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

Parameters

string $name
object|callable $macro

Return Value

void

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

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

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

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

Parameters

string $name

Return Value

bool

static void flushMacros()

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

Return Value

void

static mixed __callStatic(string $method, array $parameters)

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

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

static FileFactory fake()

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

Return Value

FileFactory

string|false store(string $path, array|string $options = [])

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

Parameters

string $path
array|string $options

Return Value

string|false

string|false storePublicly(string $path, array|string $options = [])

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

Parameters

string $path
array|string $options

Return Value

string|false

string|false storePubliclyAs(string $path, string $name, array|string $options = [])

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

Parameters

string $path
string $name
array|string $options

Return Value

string|false

string|false storeAs(string $path, string $name, array|string $options = [])

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

Parameters

string $path
string $name
array|string $options

Return Value

string|false

false|string get()

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

Return Value

false|string

Exceptions

FileNotFoundException

string clientExtension()

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

Return Value

string

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

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

Parameters

UploadedFile $file
bool $test

Return Value

UploadedFile

protected array parseOptions(array|string $options)

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

Parameters

array|string $options

Return Value

array

void __construct(string $name, resource $tempFile)

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

Parameters

string $name
resource $tempFile

Return Value

void

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

Создать новый файл-заглушку.

Parameters

string $name
string|int $kilobytes

Return Value

File

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

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

Parameters

string $name
string $content

Return Value

File

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

Создать новый файл-заглушку изображения.

Parameters

string $name
int $width
int $height

Return Value

File
END_OF_DOCUMENT_MARKER

$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/9.x/Illuminate/Http/Testing/File.html

Spec-Zone.ru

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