Класс 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

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

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

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

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

array
Список правил для проверки при обновлении
$_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 необязательно []: Список правил, которые должны быть проверены.

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

boolean

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 array

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

[]

$_deleteRulessource

protected array

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

[]

$_optionssource

protected array

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

[]

$_rulessource

protected array

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

[]

$_updateRulessource

protected array

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

[]

$_useI18nsource

protected boolean

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

false

© 2005–2016 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.
http://api.cakephp.org/3.2/class-Cake.Datasource.RulesChecker.html