ORM flavoured rules checker.
Adds ORM related features to the RulesChecker class.
string 'create'
Indicates that the checking rules to apply are those used for creating entities
string 'delete'
Indicates that the checking rules to apply are those used for deleting entities
string 'update'
Indicates that the checking rules to apply are those used for updating entities
arrayCake\Datasource\RuleInvoker>The list of rules to check during create operations
arrayCake\Datasource\RuleInvoker>The list of rules to check during delete operations
arrayList of options to pass to every callable rule
arrayCake\Datasource\RuleInvoker>The list of rules to be checked on both create and update operations
arrayCake\Datasource\RuleInvoker>The list of rules to check during update operations
boolWhether to use I18n functions for translating default error messages
Constructor. Takes the options to be passed to all rules.
Utility method for decorating any callable so that if it returns false, the correct property in the entity is marked as invalid.
Adds a link constraint rule.
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.
Adds a rule that will be applied to the entity on create operations.
Adds a rule that will be applied to the entity on delete operations.
Adds a rule that will be applied to the entity on 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'
Returns a callable that can be used as a rule for checking that the values extracted from the entity to check exist as the primary key in another table.
Validates whether links to the given association exist.
Validates whether links to the given association do not exist.
Returns a callable that can be used as a rule for checking the uniqueness of a value in the table.
Validates the count of associated records.
__construct(array<string, mixed> $options = [])
Constructor. Takes the options to be passed to all rules.
array<string, mixed> $options optional The options to pass to every rule
_addError(callableCake\Datasource\RuleInvoker $rule, array|string|null $name = null, array<string, mixed> $options = []): Cake\Datasource\RuleInvoker
Utility method for decorating any callable so that if it returns false, the correct property in the entity is marked as invalid.
callableCake\Datasource\RuleInvoker $rule The rule to decorate
array|string|null $name optional The alias for a rule or an array of options
array<string, mixed> $options optional The options containing the error message and field.
Cake\Datasource\RuleInvoker_addLinkConstraintRule(Cake\ORM\Association|string $association, string|null $errorField, string|null $message, string $linkStatus, string $ruleName): Cake\Datasource\RuleInvoker
Adds a link constraint rule.
Cake\ORM\Association|string $association The association to check for links.
string|null $errorField The name of the property to use for setting possible errors. When absent, the name is inferred from $association.
string|null $message The error message to show in case the rule does not pass.
string $linkStatus The ink status required for the check to pass.
string $ruleName The alias/name of the rule.
Cake\Datasource\RuleInvokerInvalidArgumentException_checkRules(Cake\Datasource\EntityInterface $entity, array<string, mixed> $options = [], arrayCake\Datasource\RuleInvoker> $rules = []): bool
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<string, mixed> $options optional Extra options to pass to checker functions.
arrayCake\Datasource\RuleInvoker> $rules optional The list of rules that must be checked.
booladd(callable $rule, array|string|null $name = null, array<string, mixed> $options = []): $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.
array|string|null $name optional The alias for a rule, or an array of options.
array<string, mixed> $options optional List of extra options to pass to the rule callable as second argument.
$thisaddCreate(callable $rule, array|string|null $name = null, array<string, mixed> $options = []): $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.
array|string|null $name optional The alias for a rule or an array of options.
array<string, mixed> $options optional List of extra options to pass to the rule callable as second argument.
$thisaddDelete(callable $rule, array|string|null $name = null, array<string, mixed> $options = []): $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.
array|string|null $name optional The alias for a rule, or an array of options.
array<string, mixed> $options optional List of extra options to pass to the rule callable as second argument.
$thisaddUpdate(callable $rule, array|string|null $name = null, array<string, mixed> $options = []): $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.
array|string|null $name optional The alias for a rule, or an array of options.
array<string, mixed> $options optional List of extra options to pass to the rule callable as second argument.
$thischeck(Cake\Datasource\EntityInterface $entity, string $mode, array<string, mixed> $options = []): bool
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<string, mixed> $options optional Extra options to pass to checker functions.
boolInvalidArgumentExceptioncheckCreate(Cake\Datasource\EntityInterface $entity, array<string, mixed> $options = []): bool
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<string, mixed> $options optional Extra options to pass to checker functions.
boolcheckDelete(Cake\Datasource\EntityInterface $entity, array<string, mixed> $options = []): bool
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<string, mixed> $options optional Extra options to pass to checker functions.
boolcheckUpdate(Cake\Datasource\EntityInterface $entity, array<string, mixed> $options = []): bool
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<string, mixed> $options optional Extra options to pass to checker functions.
boolexistsIn(array<string>|string $field, Cake\ORM\TableCake\ORM\Association|string $table, array<string, mixed>|string|null $message = null): Cake\Datasource\RuleInvoker
Returns a callable that can be used as a rule for checking that the values extracted from the entity to check exist as the primary key in another table.
This is useful for enforcing foreign key integrity checks.
$rules->add($rules->existsIn('author_id', 'Authors', 'Invalid Author'));
$rules->add($rules->existsIn('site_id', new SitesTable(), 'Invalid Site')); Available $options are error 'message' and 'allowNullableNulls' flag. 'message' sets a custom error message. Set 'allowNullableNulls' to true to accept composite foreign keys where one or more nullable columns are null.
array<string>|string $field The field or list of fields to check for existence by primary key lookup in the other table.
Cake\ORM\TableCake\ORM\Association|string $table The table name where the fields existence will be checked.
array<string, mixed>|string|null $message optional The error message to show in case the rule does not pass. Can also be an array of options. When an array, the 'message' key can be used to provide a message.
Cake\Datasource\RuleInvokerisLinkedTo(Cake\ORM\Association|string $association, string|null $field = null, string|null $message = null): Cake\Datasource\RuleInvoker
Validates whether links to the given association exist.
$rules->addUpdate($rules->isLinkedTo('Articles', 'article')); On a Comments table that has a belongsTo Articles association, this check would ensure that comments can only be edited as long as they are associated to an existing article.
Cake\ORM\Association|string $association The association to check for links.
string|null $field optional The name of the association property. When supplied, this is the name used to set possible errors. When absent, the name is inferred from $association.
string|null $message optional The error message to show in case the rule does not pass.
Cake\Datasource\RuleInvokerisNotLinkedTo(Cake\ORM\Association|string $association, string|null $field = null, string|null $message = null): Cake\Datasource\RuleInvoker
Validates whether links to the given association do not exist.
$rules->addDelete($rules->isNotLinkedTo('Comments', 'comments')); On a Articles table that has a hasMany Comments association, this check would ensure that articles can only be deleted when no associated comments exist.
Cake\ORM\Association|string $association The association to check for links.
string|null $field optional The name of the association property. When supplied, this is the name used to set possible errors. When absent, the name is inferred from $association.
string|null $message optional The error message to show in case the rule does not pass.
Cake\Datasource\RuleInvokerisUnique(array<string> $fields, array<string, mixed>|string|null $message = null): Cake\Datasource\RuleInvoker
Returns a callable that can be used as a rule for checking the uniqueness of a value in the table.
$rules->add($rules->isUnique(['email'], 'The email should be unique'));
allowMultipleNulls Allows any field to have multiple null values. Defaults to false.array<string> $fields The list of fields to check for uniqueness.
array<string, mixed>|string|null $message optional The error message to show in case the rule does not pass. Can also be an array of options. When an array, the 'message' key can be used to provide a message.
Cake\Datasource\RuleInvokervalidCount(string $field, int $count = 0, string $operator = '>', string|null $message = null): Cake\Datasource\RuleInvoker
Validates the count of associated records.
string $field The field to check the count on.
int $count optional The expected count.
string $operator optional The operator for the count comparison.
string|null $message optional The error message to show in case the rule does not pass.
Cake\Datasource\RuleInvokerThe list of rules to check during create operations
arrayCake\Datasource\RuleInvoker>The list of rules to check during delete operations
arrayCake\Datasource\RuleInvoker>List of options to pass to every callable rule
arrayThe list of rules to be checked on both create and update operations
arrayCake\Datasource\RuleInvoker>The list of rules to check during update operations
arrayCake\Datasource\RuleInvoker>Whether to use I18n functions for translating default error messages
bool
© 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/4.4/class-Cake.ORM.RulesChecker.html