Trait ValidatorAwareTrait
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 two constants:
DEFAULT_VALIDATOR- The default validator name.VALIDATOR_PROVIDER_NAME- The provider name the including class is assigned in validators.
If the including class also implements events the Model.buildValidator event
will be triggered when validators are created.
Property Summary
-
$_validatorClass protected
stringValidator class.
-
$_validators protected
arrayA list of validation objects indexed by name
Method Summary
-
validationDefault() public
Returns the default validator object. Subclasses can override this function to add a default validation set to the validator object.
-
validator() public
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.
Method Detail
validationDefault() ¶ public
validationDefault(Cake\Validation\Validator $validator): Cake\Validation\ValidatorReturns the default validator object. Subclasses can override this function to add a default validation set to the validator object.
Parameters
-
Cake\Validation\Validator$validator The validator that can be modified to add some rules to it.
Returns
Cake\Validation\Validatorvalidator() ¶ public
validator(string|null $name = null, Cake\Validation\Validator|null $validator = null): Cake\Validation\ValidatorReturns 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.
There are two different ways of creating and naming validation sets: by creating a new method inside your own Table subclass, or by building the validator object yourself and storing it using this method.
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');
}Otherwise, you can build the object by yourself and store it in the Table object:
$validator = new \Cake\Validation\Validator($table);
$validator
->add('email', 'valid-email', ['rule' => 'email'])
->add('password', 'valid', ['rule' => 'notBlank'])
->allowEmpty('bio');
$table->validator('forSubscription', $validator);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.
Parameters
-
string|null$name optional the name of the validation set to return
-
Cake\Validation\Validator|null$validator optional The validator instance to store, use null to get a validator.
Returns
Cake\Validation\ValidatorThrows
RuntimeException