Class ValidationSet
ValidationSet object. Holds all validation rules for a field and exposes methods to dynamically add or remove validation rules
- Cake\Validation\ValidationSet implements ArrayAccess, IteratorAggregate, Countable
Properties summary
-
$_allowEmptyprotectedboolean|string|callableDenotes if a field is allowed to be empty -
$_rulesprotectedHolds the ValidationRule objects -
$_validatePresentprotectedboolean|string|callableDenotes whether the fieldname key must be present in data array
Method Summary
-
add() public
Sets a ValidationRule $rule with a $name -
allowEmpty() public
Sets whether a field value is allowed to be empty. -
count() public
Returns the number of rules in this set -
getIterator() public
Returns an iterator for each of the rules to be applied -
isEmptyAllowed() public
Sets whether a field value is allowed to be empty. -
isPresenceRequired() public
Sets whether a field is required to be present in data array. -
offsetExists() public
Returns whether an index exists in the rule set -
offsetGet() public
Returns a rule object by its index -
offsetSet() public
Sets or replace a validation rule -
offsetUnset() public
Unsets a validation rule -
remove() public
Removes a validation rule from the set -
requirePresence() public
Sets whether a field is required to be present in data array. -
rule() public
Gets a rule for a given name if exists -
rules() public
Returns all rules for this validation set
Method Detail
add() public ¶
add( string $name , Cake\Validation\ValidationRule|array $rule )
Sets a ValidationRule $rule with a $name
Example:
$set ->add('notBlank', ['rule' => 'notBlank']) ->add('inRange', ['rule' => ['between', 4, 10])
Parameters
- string $name
- The name under which the rule should be set
-
Cake\Validation\ValidationRule|array $rule - The validation rule to be set
Returns
$this
allowEmpty() public ¶
allowEmpty( boolean|string|callable $allowEmpty )
Sets whether a field value is allowed to be empty.
Parameters
- boolean|string|callable $allowEmpty
Valid values are true, false, 'create', 'update' or a callable.
Returns
$this
count() public ¶
count( )
Returns the number of rules in this set
Returns
Implementation of
Countable::count()getIterator() public ¶
getIterator( )
Returns an iterator for each of the rules to be applied
Returns
Implementation of
IteratorAggregate::getIterator()isEmptyAllowed() public ¶
isEmptyAllowed( boolean|string|callable|null $allowEmpty null )
Sets whether a field value is allowed to be empty.
If no argument is passed the currently set allowEmpty value will be returned.
Parameters
- boolean|string|callable|null $allowEmpty optional null
Deprecated since 3.6.0 ValidationSet::isEmptyAllowed() is deprecated as a setter. Use ValidationSet::allowEmpty() instead.
Returns
isPresenceRequired() public ¶
isPresenceRequired( boolean|string|callable|null $validatePresent null )
Sets whether a field is required to be present in data array.
If no argument is passed the currently set validatePresent value will be returned.
Parameters
- boolean|string|callable|null $validatePresent optional null
Deprecated since 3.6.0 ValidationSet::isPresenceRequired() is deprecated as a setter Use ValidationSet::requirePresence() instead.
Returns
offsetExists() public ¶
offsetExists( string $index )
Returns whether an index exists in the rule set
Parameters
- string $index
- name of the rule
Returns
Implementation of
ArrayAccess::offsetExists()offsetGet() public ¶
offsetGet( string $index )
Returns a rule object by its index
Parameters
- string $index
- name of the rule
Returns
Implementation of
ArrayAccess::offsetGet()offsetSet() public ¶
offsetSet( string $index , Cake\Validation\ValidationRule|array $rule )
Sets or replace a validation rule
Parameters
- string $index
- name of the rule
-
Cake\Validation\ValidationRule|array $rule - Rule to add to $index
Implementation of
ArrayAccess::offsetSet()offsetUnset() public ¶
offsetUnset( string $index )
Unsets a validation rule
Parameters
- string $index
- name of the rule
Implementation of
ArrayAccess::offsetUnset()remove() public ¶
remove( string $name )
Removes a validation rule from the set
Example:
$set ->remove('notBlank') ->remove('inRange')
Parameters
- string $name
- The name under which the rule should be unset
Returns
$this
requirePresence() public ¶
requirePresence( boolean|string|callable $validatePresent )
Sets whether a field is required to be present in data array.
Parameters
- boolean|string|callable $validatePresent
- Valid values are true, false, 'create', 'update' or a callable.
Returns
$this
rule() public ¶
rule( string $name )
Gets a rule for a given name if exists
Parameters
- string $name
- The name under which the rule is set.
Returns
Properties detail
$_validatePresent ¶
Denotes whether the fieldname key must be present in data array
false