Contains logic for storing and checking rules on entities
RulesCheckers are used by Table classes to ensure that the current entity state satisfies the application logic and business rules.
RulesCheckers afford different rules to be applied in the create and update scenario.
Rules must be callable objects that return true/false depending on whether or not the rule has been satisfied. You can use RulesChecker::add(), RulesChecker::addCreate(), RulesChecker::addUpdate() and RulesChecker::addDelete to add rules to a checker.
Generally a Table object will invoke the rules objects, but you can manually invoke the checks by calling RulesChecker::checkCreate(), RulesChecker::checkUpdate() or RulesChecker::checkDelete().
string
'create' string
'delete' string
'update' $_createRules protected callable[]$_deleteRules protected callable[]$_options protected array$_rules protected callable[]$_updateRules protected callable[]$_useI18n protected booleanUtility method for decorating any callable so that if it returns false, the correct property in the entity is marked as invalid.
Used by top level functions checkDelete, checkCreate and checkUpdate, this function iterates an array containing the rules to be checked and checks them all.
Adds a rule that will be applied to the entity both on create and update operations.
Runs each of the rules by passing the provided entity and returns true if all of them pass. The rules to be applied are depended on the $mode parameter which can only be RulesChecker::CREATE, RulesChecker::UPDATE or RulesChecker::DELETE
Runs each of the rules by passing the provided entity and returns true if all of them pass. The rules selected will be only those specified to be run on 'create'
Runs each of the rules by passing the provided entity and returns true if all of them pass. The rules selected will be only those specified to be run on 'delete'
Runs each of the rules by passing the provided entity and returns true if all of them pass. The rules selected will be only those specified to be run on 'update'
__construct( array $options [] )
Constructor. Takes the options to be passed to all rules.
$options optional [] _addError( callable $rule , string $name , array $options )
Utility method for decorating any callable so that if it returns false, the correct property in the entity is marked as invalid.
$rule $name $options _checkRules( Cake\Datasource\EntityInterface $entity , array $options [] , array $rules [] )
Used by top level functions checkDelete, checkCreate and checkUpdate, this function iterates an array containing the rules to be checked and checks them all.
Cake\Datasource\EntityInterface $entity $options optional [] $rules optional [] add( callable $rule , string|null $name null , array $options [] )
Adds a rule that will be applied to the entity both on create and update operations.
The options array accept the following special keys:
errorField: The name of the entity field that will be marked as invalid if the rule does not pass.message: The error message to set to errorField if the rule does not pass.$rule A callable function or object that will return whether the entity is valid or not.
$name optional null $options optional [] List of extra options to pass to the rule callable as second argument.
addCreate( callable $rule , string|null $name null , array $options [] )
Adds a rule that will be applied to the entity on create operations.
The options array accept the following special keys:
errorField: The name of the entity field that will be marked as invalid if the rule does not pass.message: The error message to set to errorField if the rule does not pass.$rule A callable function or object that will return whether the entity is valid or not.
$name optional null $options optional [] List of extra options to pass to the rule callable as second argument.
addDelete( callable $rule , string|null $name null , array $options [] )
Adds a rule that will be applied to the entity on delete operations.
The options array accept the following special keys:
errorField: The name of the entity field that will be marked as invalid if the rule does not pass.message: The error message to set to errorField if the rule does not pass.$rule A callable function or object that will return whether the entity is valid or not.
$name optional null $options optional [] List of extra options to pass to the rule callable as second argument.
addUpdate( callable $rule , string|null $name null , array $options [] )
Adds a rule that will be applied to the entity on update operations.
The options array accept the following special keys:
errorField: The name of the entity field that will be marked as invalid if the rule does not pass.message: The error message to set to errorField if the rule does not pass.$rule A callable function or object that will return whether the entity is valid or not.
$name optional null $options optional [] List of extra options to pass to the rule callable as second argument.
check( Cake\Datasource\EntityInterface $entity , string $mode , array $options [] )
Runs each of the rules by passing the provided entity and returns true if all of them pass. The rules to be applied are depended on the $mode parameter which can only be RulesChecker::CREATE, RulesChecker::UPDATE or RulesChecker::DELETE
Cake\Datasource\EntityInterface $entity $mode $options optional [] checkCreate( Cake\Datasource\EntityInterface $entity , array $options [] )
Runs each of the rules by passing the provided entity and returns true if all of them pass. The rules selected will be only those specified to be run on 'create'
Cake\Datasource\EntityInterface $entity $options optional [] checkDelete( Cake\Datasource\EntityInterface $entity , array $options [] )
Runs each of the rules by passing the provided entity and returns true if all of them pass. The rules selected will be only those specified to be run on 'delete'
Cake\Datasource\EntityInterface $entity $options optional [] checkUpdate( Cake\Datasource\EntityInterface $entity , array $options [] )
Runs each of the rules by passing the provided entity and returns true if all of them pass. The rules selected will be only those specified to be run on 'update'
Cake\Datasource\EntityInterface $entity $options optional [] protected callable[]
The list of rules to be checked on both create and update operations
[]
protected boolean
Whether or not to use I18n functions for translating default error messages
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