Spec-Zone.ru › Laravel 11

Файл

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

Трейты

Условная
Макро

Свойства

static protected array $macros

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

из Macroable
protected array $allowedMimetypes

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

protected array $allowedExtensions

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

protected null|int $minimumFileSize

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

protected null|int $maximumFileSize

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

protected array $customRules

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

protected array $messages

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

protected array $data

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

protected Validator $validator

Объект валидатора, выполняющий валидацию.

static string|array|callable|null $defaultCallback

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

Методы

$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)

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

static File default()

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

static ImageFile image()

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

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

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

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

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

$this size(string|int $size)

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

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

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

$this min(string|int $size)

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

$this max(string|int $size)

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

mixed toKilobytes(string|int $size)

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

$this rules(string|array $rules)

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

bool passes(string $attribute, mixed $value)

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

array buildValidationRules()

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

array buildMimetypes()

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

bool fail(array|string $messages)

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

string|array message()

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

$this setValidator(Validator $validator)

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

$this setData(array $data)

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

Подробности

$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)

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

Параметры

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 extensions(string|array<int,string> $extensions)

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

Параметры

string|array<int,string> $extensions

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

$this

$this size(string|int $size)

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

Параметры

string|int $size

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

$this

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

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

Параметры

string|int $minSize
string|int $maxSize

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

$this

$this min(string|int $size)

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

Параметры

string|int $size

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

$this

$this max(string|int $size)

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

Параметры

string|int $size

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

$this

protected mixed toKilobytes(string|int $size)

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

Параметры

string|int $size

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

mixed

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

Spec-Zone.ru

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