Spec-Zone.ru › CakePHP 3.4

Класс RulesChecker

Содержит логику для хранения и проверки правил на сущностях

Правила RulesChecker используются классами таблиц для обеспечения того, что текущее состояние сущности удовлетворяет логике приложения и бизнес-правилам.

Правила RulesChecker позволяют применять различные правила в сценариях создания и обновления.

Добавление правил

Правила должны быть вызываемыми объектами, возвращающими 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, если правило не выполняется.

Параметры

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
Сущность, для проверки на валидность.
строка $mode
«create», «update» или «delete».
массив $options необязательно []
Дополнительные параметры для передачи функциям проверки.

Возвращает

boolean

Выбрасывает

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

checkCreate()source public 

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

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

Параметры

Cake\Datasource\EntityInterface $entity
Сущность, для проверки на валидность.
массив $options необязательно []
Дополнительные параметры для передачи функциям проверки.

Возвращает

boolean

checkDelete()source public 

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

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

Параметры

Cake\Datasource\EntityInterface $entity
Сущность, для проверки на валидность.
массив $options необязательно []
Дополнительные параметры для передачи функциям проверки.

Возвращает

boolean

checkUpdate()source public 

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

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

Параметры

Cake\Datasource\EntityInterface $entity
Сущность, для проверки на валидность.
массив $options необязательно []
Дополнительные параметры для передачи функциям проверки.

Возвращает

boolean

Подробное описание свойств

$_createRulessource

protected callable[]

Список правил для проверки при операциях создания

[]

$_deleteRulessource

protected callable[]

Список правил для проверки при операциях удаления

[]

$_optionssource

protected массив

Список параметров для передачи каждой вызываемой функции правила

[]

$_rulessource

protected callable[]

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

[]

$_updateRulessource

protected callable[]

Список правил для проверки при операциях обновления

[]

$_useI18nsource

protected boolean

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

false

© 2005–2017 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.4/class-Cake.Datasource.RulesChecker.html

Spec-Zone.ru

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