Class CakeValidationSet

__constructsource public

__construct( string $fieldName , array $ruleSet )

Constructor

Parameters

string $fieldName

The fieldname.

array $ruleSet

Rules set.

_processValidationResponsesource protected

_processValidationResponse( string $name , CakeValidationRule $rule )

Fetches the correct error message for a failed validation

Parameters

string $name

the name of the rule as it was configured

CakeValidationRule $rule

the object containing validation information

Returns

_translateArgssource protected

_translateArgs( array $args )

Applies translations to validator arguments.

Parameters

array $args

The args to translate

Returns

countsource public

count( )

Returns the number of rules in this set

Returns

Implementation of

getIteratorsource public

getIterator( )

Returns an iterator for each of the rules to be applied

Returns

Implementation of

getRulesource public

getRule( string $name )

Gets a rule for a given name if exists

Parameters

string $name

Field name.

Returns

getRulessource public

getRules( )

Returns all rules for this validation set

Returns

offsetExistssource public

offsetExists( string $index )

Returns whether an index exists in the rule set

Parameters

string $index

name of the rule

Returns

Implementation of

offsetGetsource public

offsetGet( string $index )

Returns a rule object by its index

Parameters

string $index

name of the rule

Returns

Implementation of

offsetSetsource public

offsetSet( string $index , CakeValidationRule|array $rule )

Sets or replace a validation rule.

This is a wrapper for ArrayAccess. Use setRule() directly for chainable access.

Parameters

string $index

Name of the rule.

CakeValidationRule|array $rule

Rule to add to $index.

See

Implementation of

offsetUnsetsource public

offsetUnset( string $index )

Unsets a validation rule

Parameters

string $index

name of the rule

Implementation of

removeRulesource public

removeRule( string $name )

Removes a validation rule from the set

Example:

$set
        ->removeRule('required')
        ->removeRule('inRange')

Parameters

string $name

The name under which the rule should be unset

Returns

resetsource public

reset( )

Resets internal state for all validation rules in this set

setMethodssource public

setMethods( array $methods )

Sets the list of methods to use for validation

Parameters

array $methods

$methods Methods list

setRulesource public

setRule( string $name , CakeValidationRule|array $rule )

Sets a CakeValidationRule $rule with a $name

Example:

$set
        ->setRule('required', array('rule' => 'notBlank', 'required' => true))
        ->setRule('between', array('rule' => array('lengthBetween', 4, 10))

Parameters

string $name

The name under which the rule should be set

CakeValidationRule|array $rule

The validation rule to be set

Returns

setRulessource public

setRules( array $rules array() , boolean $mergeVars true )

Sets the rules for a given field

Example:

$set->setRules(array(
        'required' => array('rule' => 'notBlank', 'required' => true),
        'inRange' => array('rule' => array('between', 4, 10)
        ));

Parameters

array $rules optional array()

The rules to be set

boolean $mergeVars optional true

[optional] If true, merges vars instead of replace. Defaults to true.

Returns

setValidationDomainsource public

setValidationDomain( string $validationDomain )

Sets the I18n domain for validation messages.

Parameters

string $validationDomain

The validation domain to be used.

validatesource public

validate( array $data , boolean $isUpdate false )

Runs all validation rules in this set and returns a list of validation errors

Parameters

array $data

Data array

boolean $isUpdate optional false

Is record being updated or created

Returns