CREATE
CREATE = 'create' : string
Indicates that the checking rules to apply are those used for creating entities
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().
add(callable $rule, string|null $name = null, array $options = array()) : $this
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.| callable | $rule | A callable function or object that will return whether the entity is valid or not. |
| string|null | $name | The alias for a rule. |
| array | $options | List of extra options to pass to the rule callable as second argument. |
addCreate(callable $rule, string|null $name = null, array $options = array()) : $this
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.| callable | $rule | A callable function or object that will return whether the entity is valid or not. |
| string|null | $name | The alias for a rule. |
| array | $options | List of extra options to pass to the rule callable as second argument. |
addUpdate(callable $rule, string|null $name = null, array $options = array()) : $this
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.| callable | $rule | A callable function or object that will return whether the entity is valid or not. |
| string|null | $name | The alias for a rule. |
| array | $options | List of extra options to pass to the rule callable as second argument. |
addDelete(callable $rule, string|null $name = null, array $options = array()) : $this
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.| callable | $rule | A callable function or object that will return whether the entity is valid or not. |
| string|null | $name | The alias for a rule. |
| array | $options | List of extra options to pass to the rule callable as second argument. |
check(\Cake\Datasource\EntityInterface $entity, string $mode, array $options = array()) : boolean
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 | The entity to check for validity. |
| string | $mode | Either 'create, 'update' or 'delete'. |
| array | $options | Extra options to pass to checker functions. |
if an invalid mode is passed.
checkCreate(\Cake\Datasource\EntityInterface $entity, array $options = array()) : boolean
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 | The entity to check for validity. |
| array | $options | Extra options to pass to checker functions. |
checkUpdate(\Cake\Datasource\EntityInterface $entity, array $options = array()) : boolean
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 | The entity to check for validity. |
| array | $options | Extra options to pass to checker functions. |
checkDelete(\Cake\Datasource\EntityInterface $entity, array $options = array()) : boolean
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 | The entity to check for validity. |
| array | $options | Extra options to pass to checker functions. |
_checkRules(\Cake\Datasource\EntityInterface $entity, array $options = array(), array $rules = array()) : boolean
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 | The entity to check for validity. |
| array | $options | Extra options to pass to checker functions. |
| array | $rules | The list of rules that must be checked. |
_addError(callable $rule, string $name, array $options) : callable
Utility method for decorating any callable so that if it returns false, the correct property in the entity is marked as invalid.
| callable | $rule | The rule to decorate |
| string | $name | The alias for a rule. |
| array | $options | The options containing the error message and field. |