Класс RulesChecker

existsInsource public

existsIn( string|array $field , object|string $table , string $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 $message необязательно null

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

Возвращает

callable
callable

isUniquesource public

isUnique( array $fields , string $message null )

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

Пример:

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

Параметры

array $fields

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

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

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

Возвращает

callable
callable

__constructsource public

__construct( array $options [] )

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

Параметры

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

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

_addErrorsource protected

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

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

Параметры

callable $rule

Правило для декорации

string $name

Алиас для правила.

array $options

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

Возвращает

callable
callable

_checkRulessource protected

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

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

Параметры

Cake\Datasource\EntityInterface $entity

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

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

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

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

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

Возвращает

boolean
bool

addsource public

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

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

Параметры

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

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

Параметры

callable $rule

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

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

Алиас для правила.

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

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

Возвращает

mixed
$this

addCreatesource public

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

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

Параметры

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

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

Параметры

callable $rule

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

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

Алиас для правила.

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

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

Возвращает

mixed
$this

addDeletesource public

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

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

Параметры

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

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

Параметры

callable $rule

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

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

Алиас для правила.

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

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

Возвращает

mixed
$this

addUpdatesource public

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

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

Параметры

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

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

Параметры

callable $rule

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

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

Алиас для правила.

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

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

Возвращает

mixed
$this

checksource 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
bool

Исключения

InvalidArgumentException
если передан недопустимый режим.

checkCreatesource public

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

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

Параметры

Cake\Datasource\EntityInterface $entity

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

массив $options необязательно []

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

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

boolean
bool

checkDeletesource public

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

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

Параметры

Cake\Datasource\EntityInterface $entity

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

массив $options необязательно []

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

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

boolean
bool

checkUpdatesource public

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

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

Параметры

Cake\Datasource\EntityInterface $entity

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

массив $options необязательно []

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

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

boolean
bool

[]

[]

[]

[]

[]

false