Spec-Zone.ru › CakePHP 4.2

Класс RuleInvoker

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

Комбинируется с Cake\Datasource\RuleChecker в качестве реализации для исключения дублирования декораций правил и обеспечения более чистого разделения обязанностей.

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

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

  • $name protected
    string|null

    Имя правила

  • $options protected
    array

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

  • $rule protected
    callable

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

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

  • __construct() public

    Конструктор

  • __invoke() public

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

  • setName() public

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

  • setOptions() public

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

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

__construct() public

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

Конструктор

Параметры

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

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

Параметры

callable $rule

Правило, которое необходимо вызвать.

?string $name

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

array $options необязательный

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

__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 $options): $this

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

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

Параметры

array $options

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

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

$this

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

$name protected

Имя правила

Тип

string|null

$options protected

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

Тип

array

$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.2/class-Cake.Datasource.RuleInvoker.html

Spec-Zone.ru

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