Spec-Zone.ru › Laravel 10

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 $callback = null, callable $default = null)

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

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

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

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

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

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

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

from Macroable
static bool hasMacro(string $name)

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

from Macroable
static void flushMacros()

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

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

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

from Macroable
mixed __call(string $method, array $parameters)

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

from Macroable
static File|null defaults(File|callable|null $callback = null)

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

from File
static File default()

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

from File
static ImageFile image()

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

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

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

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

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

from File
$this size(string|int $size)

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

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

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

from File
$this min(string|int $size)

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

from File
$this max(string|int $size)

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

from File
mixed toKilobytes(string|int $size)

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

from File
$this rules(string|array $rules)

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

from File
bool passes(string $attribute, mixed $value)

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

from File
array buildValidationRules()

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

from File
array buildMimetypes()

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

from File
bool fail(array|string $messages)

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

from File
string|array message()

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

from File
$this setValidator(Validator $validator)

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

from File
$this setData(array $data)

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

from File
void __construct()

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

dimensions(Dimensions $dimensions)

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

Details

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

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

Parameters

$value
callable $callback
callable $default

Return Value

$this|TWhenReturnType

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

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

Parameters

$value
callable $callback
callable $default

Return Value

$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/10.x/Illuminate/Validation/Rules/ImageFile.html

Spec-Zone.ru

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