Класс RulesChecker

existsIn()source public

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

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

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

Пример:

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

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

Параметры

string|array $field

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

object|string $table

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

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

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

Возвращает

callable

isUnique()source public

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

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

Пример:

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

Параметры

array $fields

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

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

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

Возвращает

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, если все они пройдены. Выбираются только те правила, которые должны быть выполнены при 'create'.

Параметры

Cake\Datasource\EntityInterface $entity

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

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

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

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

boolean

checkDelete()source public

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

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

Параметры

Cake\Datasource\EntityInterface $entity

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

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

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

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

boolean

checkUpdate()source public

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

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

Параметры

Cake\Datasource\EntityInterface $entity

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

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

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

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

boolean