Класс RulesChecker

existsIn()source public

existsIn( string|array $field , object|string $table , string|array|null $message null )

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

Это полезно для обеспечения проверки целостности внешних ключей.

Пример:

$rules->add($rules->existsIn('author_id', 'Authors', 'Invalid Author'));

$rules->add($rules->existsIn('site_id', new SitesTable(), 'Invalid Site'));

Доступные $options: ошибка 'сообщение' и флаг 'allowNullableNulls'. 'сообщение' устанавливает пользовательское сообщение об ошибке. Установите 'allowNullableNulls' в значение true, чтобы принять составные внешние ключи, где один или несколько столбцов со значениями NULL являются NULL.

Параметры

строка|массив $field

Поле или список полей для проверки существования по первичному ключу в другой таблице.

объект|строка $table

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

строка|массив|null $message опционально null

Сообщение об ошибке, отображаемое в случае, если правило не выполняется. Также может быть массивом опций. В случае массива ключ 'сообщение' может быть использован для предоставления сообщения.

Возвращает

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

isUnique()source public

isUnique( array $fields , string|array|null $message null )

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

Пример:

$rules->add($rules->isUnique(['email'], 'The email should be unique'));

Параметры

массив $fields

Список полей для проверки уникальности.

строка|массив|null $message опционально null

Сообщение об ошибке, отображаемое в случае, если правило не выполняется. Также может быть массивом опций. В случае массива ключ 'сообщение' может быть использован для предоставления сообщения.

Возвращает

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

validCount()source public

validCount( string $field , integer $count 0 , string $operator '>' , string|null $message null )

Проверяет количество связанных записей.

Параметры

строка $field

Поле, на котором проверяется количество.

целое число $count опционально 0

Ожидаемое количество.

строка $operator опционально '>'

Оператор для сравнения количества.

строка|null $message опционально null

Сообщение об ошибке, отображаемое в случае, если правило не выполняется.

Возвращает

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

__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

addDelete()source public

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

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

Опции

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

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

Параметры

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

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

строка|null $name опционально null

Псевдоним правила.

массив $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