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

Доступные параметры — 'message' (сообщение об ошибке) и флаг 'allowNullableNulls'. 'message' задаёт пользовательское сообщение об ошибке. Установите 'allowNullableNulls' в true, чтобы принять составные внешние ключи, где один или несколько столбцов с возможностью NULL являются NULL.

Параметры

string|array $field

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

object|string $table

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

string|array|null $message необязательно null

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

Возвращает

callable

isUnique()source public

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

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

Пример:

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

Параметры

array $fields

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

string|array|null $message необязательно null

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

Возвращает

callable

validCount()source public

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

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

Параметры

string $field

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

integer $count необязательно 0

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

string $operator необязательно '>'

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

string|null $message необязательно null

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

Возвращает

callable

__construct()source public

__construct( array $options [] )

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

Параметры

array $options необязательно []

Параметры, которые нужно передать каждому правилу

_addError()source protected

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

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

Параметры

callable $rule

Правило для оформления

string $name

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

array $options

Параметры, содержащие сообщение об ошибке и поле.

Возвращает

callable

_checkRules()source protected

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

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

Параметры

Cake\Datasource\EntityInterface $entity

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

array $options необязательно []

Дополнительные параметры для передачи функциям проверки.

array $rules необязательно []

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

Возвращает

boolean

add()source public

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

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

Параметры

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

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

Параметры

callable $rule

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

string|null $name необязательно null

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

array $options необязательно []

Список дополнительных параметров, которые нужно передать вызываемому объекту в качестве второго аргумента.

Возвращает

$this

addCreate()source public

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

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

Параметры

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

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

Параметры

callable $rule

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

string|null $name необязательно null

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

array $options необязательно []

Список дополнительных параметров, которые нужно передать вызываемому объекту в качестве второго аргумента.

Возвращает

$this

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