Spec-Zone.ru › CakePHP 3.7

Класс 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
    callable[]
    Список правил для проверки во время создания
  • $_deleteRules protected
    callable[]
    Список правил для проверки во время удаления
  • $_options protected
    array
    Список опций для передачи каждому вызываемому правилу
  • $_rules protected
    callable[]
    Список правил, которые проверяются при создании и обновлении
  • $_updateRules protected
    callable[]
    Список правил для проверки во время обновления
  • $_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 необязательно []
Список правил, которые необходимо проверить.

Возвращает

булево значение

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
Если передано недопустимое значение mode.

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 callable[]

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

[]

$_deleteRulessource

protected callable[]

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

[]

$_optionssource

protected array

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

[]

$_rulessource

protected callable[]

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

[]

$_updateRulessource

protected callable[]

Список правил, которые проверяются при операциях обновления.

[]

$_useI18nsource

protected boolean

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

false

© 2005–present 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.
https://api.cakephp.org/3.7/class-Cake.Datasource.RulesChecker.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API