Класс RulesChecker

Содержит логику для хранения и проверки правил на сущностях

RulesCheckers используются классами Table для обеспечения того, что текущее состояние сущности удовлетворяет логике приложения и бизнес-правилам.

RulesCheckers позволяют применять различные правила в сценариях создания и обновления.

Добавление правил

Правила должны быть вызываемыми объектами, возвращающими true/false в зависимости от того, выполнено ли правило. Вы можете использовать RulesChecker::add(), RulesChecker::addCreate(), RulesChecker::addUpdate() и RulesChecker::addDelete для добавления правил в проверяющий объект.

Выполнение проверок

Обычно объект Table вызовет объекты правил, но вы можете вручную вызвать проверки, используя RulesChecker::checkCreate(), RulesChecker::checkUpdate() или RulesChecker::checkDelete().

Прямые подклассы

Cake\ORM\RulesChecker

Пространство имен: Cake\Datasource
Расположение: Datasource/RulesChecker.php

Резюме констант

string

CREATE

'create'
string

DELETE

'delete'
string

UPDATE

'update'

Резюме свойств

$_createRules protected

callable[]
Список правил для проверки при создании
$_deleteRules protected

callable[]
Список правил для проверки при удалении
$_options protected

array
Список параметров для передачи каждому вызываемому правилу
$_rules protected

callable[]
Список правил, проверяемых как при создании, так и при обновлении
$_updateRules protected

callable[]
Список правил для проверки при обновлении
$_useI18n protected

boolean
Использовать ли функции I18n для перевода сообщений об ошибках по умолчанию

Резюме методов

__construct() public
Конструктор. Принимает параметры, передаваемые всем правилам.
_addError() protected

Вспомогательный метод для оформления любого вызываемого объекта так, чтобы при возвращении false соответствующее свойство сущности отмечалось как недействительное.
_checkRules() protected

Используется верхнеуровневыми функциями checkDelete, checkCreate и checkUpdate. Эта функция перебирает массив, содержащий правила для проверки, и проверяет их все.
add() public

Добавляет правило, которое будет применено к сущности как при создании, так и при обновлении.
addCreate() public
Добавляет правило, которое будет применено к сущности при создании.
addDelete() public
Добавляет правило, которое будет применено к сущности при удалении.
addUpdate() public
Добавляет правило, которое будет применено к сущности при обновлении.
check() public

Выполняет каждое из правил, передавая предоставленную сущность, и возвращает true, если все они проходят. Правила, подлежащие применению, зависят от параметра $mode, который может быть только RulesChecker::CREATE, RulesChecker::UPDATE или RulesChecker::DELETE
checkCreate() public

Выполняет каждое из правил, передавая предоставленную сущность, и возвращает true, если все они проходят. Выбираются только те правила, которые указаны для выполнения при создании.
checkDelete() public

Выполняет каждое из правил, передавая предоставленную сущность, и возвращает true, если все они проходят. Выбираются только те правила, которые указаны для выполнения при удалении.
checkUpdate() public

Выполняет каждое из правил, передавая предоставленную сущность, и возвращает true, если все они проходят. Выбираются только те правила, которые указаны для выполнения при обновлении.

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

__construct()source public

__construct( array $options = [] )

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

Параметры

массив $options опционально []: Параметры, передаваемые каждому правилу

_addError()source protected

_addError( callable $rule , string $name , array $options )

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

Параметры

вызываемый объект $rule: Правило для оформления
строка $name: Псевдоним правила.
массив $options: Параметры, содержащие сообщение об ошибке и поле.

Возвращает

вызываемый объект

_checkRules()source protected

_checkRules( Cake\Datasource\EntityInterface $entity , array $options = [] , array $rules = [] )

Используется верхнеуровневыми функциями checkDelete, checkCreate и checkUpdate. Эта функция перебирает массив, содержащий правила для проверки, и проверяет их все.

Параметры

Cake\Datasource\EntityInterface $entity: Сущность для проверки на валидность.
массив $options опционально []: Дополнительные параметры для передачи функциям проверяющего объекта.
массив $rules опционально []: Список правил, которые должны быть проверены.

Возвращает

булево значение

add()source public

add( callable $rule , string|null $name = null , array $options = [] )

Добавляет правило, которое будет применено к сущности как при создании, так и при обновлении.

Параметры

Массив параметров принимает следующие специальные ключи:

errorField: Название поля сущности, которое будет помечено как недействительное, если правило не выполнится.
message: Сообщение об ошибке для установки в errorField если правило не выполнится.

Параметры

вызываемый объект $rule: Вызываемая функция или объект, возвращающие, является ли сущность валидной или нет.
строка|null $name опционально null: Псевдоним правила.
массив $options опционально []: Список дополнительных параметров для передачи вызываемому правилу в качестве второго аргумента.

Возвращает

$this

addCreate()source public

addCreate( callable $rule , string|null $name = null , array $options = [] )

Добавляет правило, которое будет применено к сущности при создании.

Параметры

Массив параметров принимает следующие специальные ключи:

errorField: Название поля сущности, которое будет помечено как недействительное, если правило не выполнится.
message: Сообщение об ошибке для установки в errorField если правило не выполнится.

Параметры

вызываемый объект $rule: Вызываемая функция или объект, возвращающие, является ли сущность валидной или нет.
строка|null $name опционально null: Псевдоним правила.
массив $options опционально []: Список дополнительных параметров для передачи вызываемому правилу в качестве второго аргумента.

Возвращает

$this

END_OF_DOCUMENT_MARKER

addDelete()source public

addDelete( callable $rule , string|null $name = null , array $options = [] )

Добавляет правило, которое будет применено к сущности при операциях удаления.

Параметры

Массив параметров может содержать следующие специальные ключи:

errorField: Имя поля сущности, которое будет помечено как некорректное, если правило не выполнится.
message: Сообщение об ошибке, которое будет установлено для errorField , если правило не выполнится.

Параметры

callable $rule: Функция или объект, который вернёт, является ли сущность корректной.
string|null $name необязательно null: Псевдоним правила.
array $options необязательно []: Список дополнительных параметров, которые будут переданы функции-правилу в качестве второго аргумента.

Возвращает

$this

addUpdate()source public

addUpdate( callable $rule , string|null $name = null , array $options = [] )

Добавляет правило, которое будет применено к сущности при операциях обновления.

Параметры

Массив параметров может содержать следующие специальные ключи:

errorField: Имя поля сущности, которое будет помечено как некорректное, если правило не выполнится.
message: Сообщение об ошибке, которое будет установлено для errorField , если правило не выполнится.

Параметры

callable $rule: Функция или объект, который вернёт, является ли сущность корректной.
string|null $name необязательно null: Псевдоним правила.
array $options необязательно []: Список дополнительных параметров, которые будут переданы функции-правилу в качестве второго аргумента.

Возвращает

$this

check()source public

check( Cake\Datasource\EntityInterface $entity , string $mode , array $options = [] )

Выполняет каждое правило, передавая предоставленную сущность, и возвращает true, если все они выполнены. Применяемые правила зависят от параметра $mode, который может быть только RulesChecker::CREATE, RulesChecker::UPDATE или RulesChecker::DELETE

Параметры

Cake\Datasource\EntityInterface $entity: Сущность, для проверки корректности.
string $mode: Значение 'create', 'update' или 'delete'.
array $options необязательно []: Дополнительные параметры для передачи функциям проверки.

Возвращает

boolean

Возможные исключения

InvalidArgumentException
если передан неверный режим.

checkCreate()source public

checkCreate( Cake\Datasource\EntityInterface $entity , array $options = [] )

Выполняет каждое правило, передавая предоставленную сущность, и возвращает true, если все они выполнены. Выбираются только правила, указанные для выполнения при 'создании'.

Параметры

Cake\Datasource\EntityInterface $entity: Сущность, для проверки корректности.
array $options необязательно []: Дополнительные параметры для передачи функциям проверки.

Возвращает

boolean

checkDelete()source public

checkDelete( Cake\Datasource\EntityInterface $entity , array $options = [] )

Выполняет каждое правило, передавая предоставленную сущность, и возвращает true, если все они выполнены. Выбираются только правила, указанные для выполнения при 'удалении'.

Параметры

Cake\Datasource\EntityInterface $entity: Сущность, для проверки корректности.
array $options необязательно []: Дополнительные параметры для передачи функциям проверки.

Возвращает

boolean

checkUpdate()source public

checkUpdate( Cake\Datasource\EntityInterface $entity , array $options = [] )

Выполняет каждое правило, передавая предоставленную сущность, и возвращает true, если все они выполнены. Выбираются только правила, указанные для выполнения при 'обновлении'.

Параметры

Cake\Datasource\EntityInterface $entity: Сущность, для проверки корректности.
array $options необязательно []: Дополнительные параметры для передачи функциям проверки.

Возвращает

boolean

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

$_createRulessource

protected callable[]

Список правил для проверки при операциях создания

[]

$_deleteRulessource

protected callable[]

Список правил для проверки при операциях удаления

[]

$_optionssource

protected array

Список параметров для передачи каждому вызываемому правилу

[]

$_rulessource

protected callable[]

Список правил, которые проверяются как при создании, так и при обновлении.

[]

$_updateRulessource

protected callable[]

Список правил для проверки при операциях обновления

[]

$_useI18nsource

protected boolean

Использовать ли функции I18n для перевода сообщений об ошибках по умолчанию

false

© 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/3.6/class-Cake.Datasource.RulesChecker.html