Class ValidationSet
ValidationSet object. Holds all validation rules for a field and exposes methods to dynamically add or remove validation rules
Property Summary
-
$_allowEmpty protected
bool|string|callableDenotes if a field is allowed to be empty
-
$_rules protected
Cake\Validation\ValidationRule[]Holds the ValidationRule objects
-
$_validatePresent protected
bool|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): $thisSets 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
$thisallowEmpty() ¶ public
allowEmpty(bool|string|callable $allowEmpty): $thisSets whether a field value is allowed to be empty.
Parameters
-
bool|string|callable$allowEmpty Valid values are true, false, 'create', 'update' or a callable.
Returns
$thisgetIterator() ¶ public
getIterator(): ArrayIteratorReturns an iterator for each of the rules to be applied
Returns
ArrayIteratorisEmptyAllowed() ¶ public
isEmptyAllowed(bool|string|callable|null $allowEmpty = null): bool|string|callableSets whether a field value is allowed to be empty.
If no argument is passed the currently set allowEmpty value will be returned.
Parameters
-
bool|string|callable|null$allowEmpty optional Deprecated since 3.6.0 ValidationSet::isEmptyAllowed() is deprecated as a setter. Use ValidationSet::allowEmpty() instead.
Returns
bool|string|callableisPresenceRequired() ¶ public
isPresenceRequired(bool|string|callable|null $validatePresent = null): bool|string|callableSets 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
-
bool|string|callable|null$validatePresent optional Deprecated since 3.6.0 ValidationSet::isPresenceRequired() is deprecated as a setter Use ValidationSet::requirePresence() instead.
Returns
bool|string|callableoffsetExists() ¶ public
offsetExists(string $index): boolReturns whether an index exists in the rule set
Parameters
-
string$index name of the rule
Returns
booloffsetGet() ¶ public
offsetGet(string $index): Cake\Validation\ValidationRuleReturns a rule object by its index
Parameters
-
string$index name of the rule
Returns
Cake\Validation\ValidationRuleoffsetSet() ¶ public
offsetSet(string $index, Cake\Validation\ValidationRule|array $rule): voidSets or replace a validation rule
Parameters
-
string$index name of the rule
-
Cake\Validation\ValidationRule|array$rule Rule to add to $index
Returns
voidoffsetUnset() ¶ public
offsetUnset(string $index): voidUnsets a validation rule
Parameters
-
string$index name of the rule
Returns
voidremove() ¶ public
remove(string $name): $thisRemoves 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
$thisrequirePresence() ¶ public
requirePresence(bool|string|callable $validatePresent): $thisSets whether a field is required to be present in data array.
Parameters
-
bool|string|callable$validatePresent Valid values are true, false, 'create', 'update' or a callable.
Returns
$thisrule() ¶ public
rule(string $name): Cake\Validation\ValidationRule|nullGets a rule for a given name if exists
Parameters
-
string$name The name under which the rule is set.
Returns
Cake\Validation\ValidationRule|nullrules() ¶ public
rules(): Cake\Validation\ValidationRule[]Returns all rules for this validation set
Returns
Cake\Validation\ValidationRule[]Property Detail
$_validatePresent ¶ protected
Denotes whether the fieldname key must be present in data array
Type
bool|string|callable