A trait that provides methods for building and interacting with Validators.
This trait is useful when building ORM like features where the implementing class wants to build and customize a variety of validator instances.
This trait expects that classes including it define three constants:
DEFAULT_VALIDATOR - The default validator name.VALIDATOR_PROVIDER_NAME - The provider name the including class is assigned in validators.BUILD_VALIDATOR_EVENT - The name of the event to be triggred when validators are built.If the including class also implements events the Model.buildValidator event will be triggered when validators are created.
stringValidator class.
\Cake\Validation\Validator[]A list of validation objects indexed by name
Returns the validation rules tagged with $name. It is possible to have multiple different named validation sets, this is useful when you need to use varying rules when saving from different routines in your system.
Returns the default validator object. Subclasses can override this function to add a default validation set to the validator object.
createValidator(string $name)
Creates a validator using a custom method inside your class.
This method is used only to build a new validator and it does not store it in your object. If you want to build and reuse validators, use getValidator() method instead.
string $name The name of the validation set to create.
\Cake\Validation\ValidatorRuntimeExceptiongetValidator(?string $name)
Returns the validation rules tagged with $name. It is possible to have multiple different named validation sets, this is useful when you need to use varying rules when saving from different routines in your system.
If a validator has not been set earlier, this method will build a valiator using a method inside your class.
For example, if you wish to create a validation set called 'forSubscription', you will need to create a method in your Table subclass as follows:
public function validationForSubscription($validator)
{
return $validator
->add('email', 'valid-email', ['rule' => 'email'])
->add('password', 'valid', ['rule' => 'notBlank'])
->requirePresence('username');
}
$validator = $this->getValidator('forSubscription'); You can implement the method in validationDefault in your Table subclass should you wish to have a validation set that applies in cases where no other set is specified.
If a $name argument has not been provided, the default validator will be returned. You can configure your default validator name in a DEFAULT_VALIDATOR class constant.
string|null $name optional The name of the validation set to return.
\Cake\Validation\ValidatorhasValidator(string $name)
Checks whether or not a validator has been set.
string $name The name of a validator.
boolsetValidator(string $name, \Cake\Validation\Validator $validator)
This method stores a custom validator under the given name.
You can build the object by yourself and store it in your object:
$validator = new \Cake\Validation\Validator($table);
$validator
->add('email', 'valid-email', ['rule' => 'email'])
->add('password', 'valid', ['rule' => 'notBlank'])
->allowEmpty('bio');
$this->setValidator('forSubscription', $validator); string $name The name of a validator to be set.
\Cake\Validation\Validator $validator Validator object to be set.
$thisvalidationDefault(\Cake\Validation\Validator $validator)
Returns the default validator object. Subclasses can override this function to add a default validation set to the validator object.
\Cake\Validation\Validator $validator The validator that can be modified to add some rules to it.
\Cake\Validation\ValidatorvalidationMethodExists(string $name)
Checks if validation method exists.
string $name Validation method name.
boolValidator class.
stringA list of validation objects indexed by name
\Cake\Validation\Validator[]
© 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.1/trait-Cake.Validation.ValidatorAwareTrait.html