Spec-Zone.ru › Laravel 11

ImageFile

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

Трейты

Conditionable
Macroable

Свойства

статический защищенный массив $macros

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

из Macroable
защищенный массив $allowedMimetypes

Типы MIME, которым должен соответствовать данный файл. Этот массив также может содержать расширения файлов.

из File
защищенный массив $allowedExtensions

Расширения, которым должен соответствовать данный файл.

из File
защищенный null|int $minimumFileSize

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

из File
защищенный null|int $maximumFileSize

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

из File
защищенный массив $customRules

Массив пользовательских правил, которые будут объединены с правилами валидации.

из File
защищенный массив $messages

Сообщение об ошибке после валидации, если таковое имеется.

из File
защищенный массив $data

Данные, подлежащие валидации.

из File
защищенный Validator $validator

Валидатор, выполняющий валидацию.

из File
статический string|array|callable|null $defaultCallback

Обратный вызов, который сгенерирует «стандартную» версию правила файла.

из File

Методы

$this|TWhenReturnType when($value = null, callable|null $callback = null, callable|null $default = null)

Примените обратный вызов, если заданное «значение» истинно (или разрешается до истинного).

из Conditionable
$this|TUnlessReturnType unless($value = null, callable|null $callback = null, callable|null $default = null)

Примените обратный вызов, если заданное «значение» ложно (или разрешается до ложного).

из Conditionable
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 File|null defaults(File|callable|null $callback = null)

Установить обратный вызов по умолчанию, используемый для определения правил по умолчанию для файла.

из File
static File default()

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

из File
static ImageFile image()

Ограничить загруженный файл только типами изображений.

из File
static File types(string|array<int,string> $mimetypes)

Ограничить загруженный файл заданными типами MIME или расширениями файлов.

из File
$this extensions(string|array<int,string> $extensions)

Ограничить загруженный файл заданными расширениями файлов.

из File
$this size(string|int $size)

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

из File
$this between(string|int $minSize, string|int $maxSize)

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

из File
$this min(string|int $size)

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

из File
$this max(string|int $size)

Указать, что загруженный файл должен быть не больше заданного количества килобайт.

из File
mixed toKilobytes(string|int $size)

Преобразовать потенциально удобочитаемый размер файла в килобайты.

из File
$this rules(string|array $rules)

Укажите дополнительные правила проверки, которые должны быть объединены с правилами по умолчанию во время проверки.

из File
bool passes(string $attribute, mixed $value)

Определить, проходит ли правило проверки.

из File
array buildValidationRules()

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

из File
array buildMimetypes()

Разделить заданные mimetypes на расширения и вернуть массив правильных правил для проверки.

из File
bool fail(array|string $messages)

Добавляет заданные ошибки и возвращает false.

из File
string|array message()

Получить сообщение об ошибке проверки.

из File
$this setValidator(Validator $validator)

Установить текущий валидатор.

из File
$this setData(array $data)

Установить текущие данные для проверки.

из File
void __construct()

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

dimensions(Dimensions $dimensions)

Ограничения размера для загруженного файла.

Подробности

$this|TWhenReturnType when($value = null, callable|null $callback = null, callable|null $default = null)

Примените обратный вызов, если заданное "значение" истинно.

Параметры

$value
callable|null $callback
callable|null $default

Значение возврата

$this|TWhenReturnType

$this|TUnlessReturnType unless($value = null, callable|null $callback = null, callable|null $default = null)

Примените обратный вызов, если заданное "значение" ложно.

Параметры

$value
callable|null $callback
callable|null $default

Значение возврата

$this|TUnlessReturnType

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 File|null defaults(File|callable|null $callback = null)

Установить по умолчанию вызываемую функцию для определения правил по умолчанию для файла.

Если аргументы не переданы, возвращается конфигурация правил по умолчанию для файла.

Parameters

File|callable|null $callback

Return Value

File|null

static File default()

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

Return Value

File

static ImageFile image()

Ограничить загружаемый файл только типами изображений.

Return Value

ImageFile

static File types(string|array<int,string> $mimetypes)

Ограничить загружаемый файл заданными MIME-типами или расширениями файлов.

Parameters

string|array<int,string> $mimetypes

Return Value

File

$this extensions(string|array<int,string> $extensions)

Ограничить загружаемый файл заданными расширениями файлов.

Parameters

string|array<int,string> $extensions

Return Value

$this

$this size(string|int $size)

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

Parameters

string|int $size

Return Value

$this

$this between(string|int $minSize, string|int $maxSize)

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

Parameters

string|int $minSize
string|int $maxSize

Return Value

$this

$this min(string|int $size)

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

Parameters

string|int $size

Return Value

$this

$this max(string|int $size)

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

Parameters

string|int $size

Return Value

$this

protected mixed toKilobytes(string|int $size)

Преобразовать потенциально удобочитаемый размер файла в килобайты.

Parameters

string|int $size

Return Value

mixed

$this rules(string|array $rules)

Указать дополнительные правила валидации, которые должны быть объединены с правилами по умолчанию во время валидации.

Parameters

string|array $rules

Return Value

$this

bool passes(string $attribute, mixed $value)

Определить, проходит ли правило валидации.

Parameters

string $attribute
mixed $value

Return Value

bool

protected array buildValidationRules()

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

Return Value

array

protected array buildMimetypes()

Разделить заданные mimetypes на расширения и вернуть массив правильных правил для проверки.

Return Value

array

protected bool fail(array|string $messages)

Добавляет указанные ошибки и возвращает false.

Параметры

array|string $messages

Значение результата

bool

string|array message()

Получить сообщение об ошибке валидации.

Значение результата

string|array

$this setValidator(Validator $validator)

Установить текущий валидатор.

Параметры

Validator $validator

Значение результата

$this

$this setData(array $data)

Установить текущие данные для валидации.

Параметры

array $data

Значение результата

$this

void __construct()

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

Значение результата

void

dimensions(Dimensions $dimensions)

Ограничения по размерам загружаемого файла.

Параметры

Dimensions $dimensions

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Validation/Rules/ImageFile.html

Spec-Zone.ru

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