Spec-Zone.ru › CakePHP 4.4

Класс RuleInvoker

Содержит логику вызова правила приложения.

Объединён с {@link \Cake\Datasource\RulesChecker} в качестве реализации, чтобы избежать дублирования декорирования правил и обеспечить более чистое разделение обязанностей.

Пространство имён: Cake\Datasource

Краткое описание свойств

  • $name protected
    string|null

    Имя правила

  • $options protected
    array<string, mixed>

    Параметры правила

  • $rule protected
    callable

    Вызываемый объект правила

Краткое описание методов

  • __construct() public

    Конструктор

  • __invoke() public

    Вызов правила.

  • setName() public

    Установить имя правила.

  • setOptions() public

    Установить параметры для вызова правила.

Подробное описание методов

__construct() public

__construct(callable $rule, ?string $name, array<string, mixed> $options = [])

Конструктор

Параметры

  • errorField поле, в которое должны быть записаны ошибки.
  • message сообщение об ошибке.

Отдельные правила могут иметь дополнительные параметры, которые могут быть установлены здесь. Любые параметры будут переданы в правило в качестве части области видимости правила $scope.

Параметры

callable $rule

Правило, которое нужно вызвать.

?string $name

Имя правила. Используется в сообщениях об ошибках.

array<string, mixed> $options optional

Параметры правила. Смотрите выше.

__invoke() public

__invoke(Cake\Datasource\EntityInterface $entity, array $scope): bool

Вызов правила.

Параметры

Cake\Datasource\EntityInterface $entity

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

array $scope

Область видимости/параметры правила.

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

bool

setName() public

setName(string|null $name): $this

Установить имя правила.

Будут установлены только ненулевые имена.

Параметры

string|null $name

Имя для установки.

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

$this

setOptions() public

setOptions(array<string, mixed> $options): $this

Установить параметры для вызова правила.

Старые параметры будут объединены с новыми.

Параметры

array<string, mixed> $options

Параметры для установки.

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

$this

Подробное описание свойств

$name protected

Имя правила

Тип

string|null

$options protected

Параметры правила

Тип

array<string, mixed>

$rule protected

Вызываемый объект правила

Тип

callable

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/class-Cake.Datasource.RuleInvoker.html

Spec-Zone.ru

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