Spec-Zone.ru › Laravel 9

Файл

класс Файл реализует Rule, DataAwareRule, ValidatorAwareRule (Просмотреть исходный код)

Трейты

Conditionable
Macroable

Свойства

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Методы

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

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

из Conditionable
$this|TUnlessReturnType unless($value = null, callable $callback = null, callable $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)

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

static File default()

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

static ImageFile image()

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

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

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

$this size(int $kilobytes)

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

$this between(int $minKilobytes, int $maxKilobytes)

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

$this min(int $kilobytes)

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

$this max(int $kilobytes)

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

$this rules(string|array $rules)

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

bool passes(string $attribute, mixed $value)

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

array buildValidationRules()

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

array buildMimetypes()

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

bool fail(array|string $messages)

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

string|array message()

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

$this setValidator(Validator $validator)

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

$this setData(array $data)

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

Подробности

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

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

Параметры

$value
callable $callback
callable $default

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

$this|TWhenReturnType

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

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

Параметры

$value
callable $callback
callable $default

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

$this|TUnlessReturnType
END_OF_DOCUMENT_MARKER

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

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

Параметры

string $name
object|callable $macro

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

void

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

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

Параметры

object $mixin
bool $replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

string $name

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

bool

static void flushMacros()

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

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

void

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

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

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

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

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

Параметры

File|callable|null $callback

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

File|null

static File default()

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

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

File

static ImageFile image()

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

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

ImageFile

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

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

Параметры

string|array<int,string> $mimetypes

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

File

$this size(int $kilobytes)

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

Параметры

int $kilobytes

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

$this

$this between(int $minKilobytes, int $maxKilobytes)

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

Параметры

int $minKilobytes
int $maxKilobytes

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

$this

$this min(int $kilobytes)

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

Параметры

int $kilobytes

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

$this

$this max(int $kilobytes)

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

Параметры

int $kilobytes

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

$this

$this rules(string|array $rules)

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

Параметры

string|array $rules

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

$this

bool passes(string $attribute, mixed $value)

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

Параметры

string $attribute
mixed $value

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

bool

protected array buildValidationRules()

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

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

array

protected array buildMimetypes()

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

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

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

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

Spec-Zone.ru

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