Class yii\validators\EachValidator

All Classes | Properties | Methods

Inheritance	yii\validators\EachValidator » yii\validators\Validator » yii\base\Component » yii\base\BaseObject
Implements	yii\base\Configurable
Available since version	2.0.4
Source Code	https://github.com/yiisoft/yii2/blob/master/framework/validators/EachValidator.php

EachValidator validates an array by checking each of its elements against an embedded validation rule.

class MyModel extends Model
{
    public $categoryIDs = [];

    public function rules()
    {
        return [
            // checks if every category ID is an integer
            ['categoryIDs', 'each', 'rule' => ['integer']],
        ]
    }
}

Note: This validator will not work with inline validation rules in case of usage outside the model scope, e.g. via validate() method.

Note: EachValidator is meant to be used only in basic cases, you should consider usage of tabular input, using several models for the more complex case.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$allowMessageFromRule	boolean	Whether to use error message composed by validator declared via $rule if its validation fails.	yii\validators\EachValidator
$attributeNames	array	Attribute names. This property is read-only.	yii\validators\Validator
$attributes	array\|string	Attributes to be validated by this validator.	yii\validators\Validator
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component. This property is read-only.	yii\base\Component
$builtInValidators	array	List of built-in validators (name => class or configuration)	yii\validators\Validator
$enableClientValidation	boolean	Whether to enable client-side validation for this validator.	yii\validators\Validator
$except	array\|string	Scenarios that the validator should not be applied to.	yii\validators\Validator
$isEmpty	callable	A PHP callable that replaces the default implementation of isEmpty().	yii\validators\Validator
$message	string	The user-defined error message.	yii\validators\Validator
$on	array\|string	Scenarios that the validator can be applied to.	yii\validators\Validator
$rule	array\|yii\validators\Validator	Definition of the validation rule, which should be used on array values.	yii\validators\EachValidator
$skipOnEmpty	boolean	Whether this validation rule should be skipped if the attribute value is null or an empty string.	yii\validators\Validator
$skipOnError	boolean	Whether this validation rule should be skipped if the attribute being validated already has some validation error according to some previous rules.	yii\validators\Validator
$stopOnFirstError	boolean	Whether to stop validation once first error among attribute value elements is detected.	yii\validators\EachValidator
$validationAttributes	array	List of attribute names. This property is read-only.	yii\validators\Validator
$when	callable	A PHP callable whose return value determines whether this validator should be applied.	yii\validators\Validator
$whenClient	string	A JavaScript function name whose return value determines whether this validator should be applied on the client-side.	yii\validators\Validator

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Component
__clone()	This method is called after the object is created by cloning an existing one.	yii\base\Component
__construct()	Constructor.	yii\base\BaseObject
__get()	Returns the value of a component property.	yii\base\Component
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Component
__set()	Sets the value of a component property.	yii\base\Component
__unset()	Sets a component property to be null.	yii\base\Component
addError()	Adds an error about the specified attribute to the model object.	yii\validators\Validator
attachBehavior()	Attaches a behavior to this component.	yii\base\Component
attachBehaviors()	Attaches a list of behaviors to the component.	yii\base\Component
behaviors()	Returns a list of behaviors that this component should behave as.	yii\base\Component
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\Component
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Component
className()	Returns the fully qualified name of this class.	yii\base\BaseObject
clientValidateAttribute()	Returns the JavaScript needed for performing client-side validation.	yii\validators\Validator
createValidator()	Creates a validator object.	yii\validators\Validator
detachBehavior()	Detaches a behavior from the component.	yii\base\Component
detachBehaviors()	Detaches all behaviors from the component.	yii\base\Component
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
getAttributeNames()	Returns cleaned attribute names without the `!` character at the beginning.	yii\validators\Validator
getBehavior()	Returns the named behavior object.	yii\base\Component
getBehaviors()	Returns all behaviors attached to this component.	yii\base\Component
getClientOptions()	Returns the client-side validation options.	yii\validators\Validator
getValidationAttributes()	Returns a list of attributes this validator applies to.	yii\validators\Validator
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\Component
hasProperty()	Returns a value indicating whether a property is defined for this component.	yii\base\Component
init()	Initializes the object.	yii\validators\EachValidator
isActive()	Returns a value indicating whether the validator is active for the given scenario and attribute.	yii\validators\Validator
isEmpty()	Checks if the given value is empty.	yii\validators\Validator
off()	Detaches an existing event handler from this component.	yii\base\Component
on()	Attaches an event handler to an event.	yii\base\Component
trigger()	Triggers an event.	yii\base\Component
validate()	Validates a given value.	yii\validators\Validator
validateAttribute()	Validates a single attribute.	yii\validators\EachValidator
validateAttributes()	Validates the specified object.	yii\validators\Validator

Protected Methods

Hide inherited methods

Method	Description	Defined By
formatMessage()	Formats a mesage using the I18N, or simple strtr if `\Yii::$app` is not available.	yii\validators\Validator
validateValue()	Validates a value.	yii\validators\EachValidator

Property Details

$allowMessageFromRule public property

Whether to use error message composed by validator declared via $rule if its validation fails. If enabled, error message specified for this validator itself will appear only if attribute value is not an array. If disabled, own error message value will be used always.

public boolean $allowMessageFromRule = true

$rule public property

Definition of the validation rule, which should be used on array values. It should be specified in the same format as at yii\base\Model::rules(), except it should not contain attribute list as the first element. For example:

['integer']
['match', 'pattern' => '/[a-z]/is']

Please refer to yii\base\Model::rules() for more details.

public array|yii\validators\Validator $rule = null

$stopOnFirstError public property (available since version 2.0.11)

Whether to stop validation once first error among attribute value elements is detected. When enabled validation will produce single error message on attribute, when disabled - multiple error messages mya appear: one per each invalid value. Note that this option will affect only validateAttribute() value, while validateValue() will not be affected.

public boolean $stopOnFirstError = true

Method Details

init() public method

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )

validateAttribute() public method

Validates a single attribute.

Child classes must implement this method to provide the actual validation logic.

public void validateAttribute ( $model, $attribute )
$model	yii\base\Model	The data model to be validated
$attribute	string	The name of the attribute to be validated.

validateValue() protected method

Validates a value.

A validator class can implement this method to support data validation out of the context of a data model.

protected array\|null validateValue ( $value )
$value	mixed	The data value to be validated.
return	array\|null	The error message and the array of parameters to be inserted into the error message. `php if (!$valid) { `return [$this->message, [ 'param1' => $this->param1, 'formattedLimit' => Yii::$app->formatter->asShortSize($this->getSizeLimit()), 'mimeTypes' => implode(', ', $this->mimeTypes), 'param4' => 'etc...', ]];` } return null; ` for this example `message` template can contain `{param1}`, `{formattedLimit}`, `{mimeTypes}`, `{param4}` Null should be returned if the data is valid.
throws	yii\base\NotSupportedException	if the validator does not supporting data validation without a model