Class yii\validators\EachValidator

继承yii\validators\EachValidator » yii\validators\Validator » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable
可用自版本2.0.4
源代码 https://github.com/yiisoft/yii2/blob/master/framework/validators/EachValidator.php

EachValidator 通过根据嵌入式验证规则检查每个元素来验证数组.

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

    public function rules()
    {
        return [
            // 检查每个类别 ID 是否是整数
            ['categoryIDs', 'each', 'rule' => ['integer']],
        ]
    }
}

Note: 如果在模型范围之外, 该验证器将无法使用内联验证规则, eg. 通过 validate() 方法.

Note: EachValidator 仅用于基本情况, 你应该考虑使用表格式输入, 使用多个模型来处理更复杂的情况.

公共属性

隐藏继承的属性

属性类型描述定义在
$allowMessageFromRule boolean 如果验证失败, 是否使用通过 $rule 声明的验证器组成的错误消息. yii\validators\EachValidator
$attributeNames array 属性名称. 该属性是只读的. yii\validators\Validator
$attributes array|string 要由此验证器验证的属性. yii\validators\Validator
$behaviors yii\base\Behavior[] 附加到此组件的行为列表. 该属性是只读的. yii\base\Component
$builtInValidators array 内置验证器列表(键值对(name => class)或配置). yii\validators\Validator
$enableClientValidation boolean 是否为此验证器启用客户端验证. yii\validators\Validator
$except array|string 验证器不应该应用的场景. yii\validators\Validator
$isEmpty callable PHP 回调函数, 它取代 isEmpty() 的默认实现. yii\validators\Validator
$message string 用户定义的错误消息. yii\validators\Validator
$on array|string 验证器可以应用的场景. yii\validators\Validator
$rule array|yii\validators\Validator 验证规则的定义, 应该在数组值上使用. yii\validators\EachValidator
$skipOnEmpty boolean 如果属性值为null或空字符串, 是否应跳过此验证规则. yii\validators\Validator
$skipOnError boolean 如果验证的属性已根据某些先前的规则已经存在某些验证错误, 是否应跳过此验证规则. yii\validators\Validator
$stopOnFirstError boolean 是否在检测到属性值元素中的第一个错误时停止验证. yii\validators\EachValidator
$validationAttributes array 属性名称列表. 该属性是只读的. yii\validators\Validator
$when callable PHP 回调函数, 其返回值确定是否应该应用此验证器. yii\validators\Validator
$whenClient string 一个 JavaScript 函数名, 其返回值决定是否应在客户端应用此验证器. yii\validators\Validator

公共方法

隐藏继承的方法

方法描述定义在
__call() 调用不是类方法的指定的方法. yii\base\Component
__clone() 在通过克隆现有对象创建对象之后调用此方法. yii\base\Component
__construct() 构造函数. yii\base\BaseObject
__get() 返回组件属性的值. yii\base\Component
__isset() 检查属性是否已设置, 即已定义且不为null. yii\base\Component
__set() 设置组件属性的值. yii\base\Component
__unset() 将组件属性设置为null. yii\base\Component
addError() 将有关指定属性的错误添加到模型对象. yii\validators\Validator
attachBehavior() 将行为附加到此组件. yii\base\Component
attachBehaviors() 将行为列表附加到组件. yii\base\Component
behaviors() 返回此组件应该具有的行为列表. yii\base\Component
canGetProperty() 返回一个值, 指示属性是否可读取. yii\base\Component
canSetProperty() 返回一个值, 指示属性是否可设置. yii\base\Component
className() 返回此类的完全限定名称. yii\base\BaseObject
clientValidateAttribute() 返回执行客户端验证所需的 JavaScript. yii\validators\Validator
createValidator() 创建一个验证器对象. yii\validators\Validator
detachBehavior() 从组件中分离一个行为. yii\base\Component
detachBehaviors() 分离组件中的所有行为. yii\base\Component
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件. yii\base\Component
getAttributeNames() 返回清理后的属性名称, 开头不带!字符. yii\validators\Validator
getBehavior() 返回指定的行为对象. yii\base\Component
getBehaviors() 返回附加到此组件的所有行为. yii\base\Component
getClientOptions() 返回客户端验证选项. yii\validators\Validator
getValidationAttributes() 返回此验证器适用的属性列表. yii\validators\Validator
hasEventHandlers() 返回一个值, 指示是否有任何处理程序附加到指定的事件. yii\base\Component
hasMethod() 返回一个值, 指示方法是否已定义. yii\base\Component
hasProperty() 返回一个值, 指示属性是否已定义. yii\base\Component
init() 初始化对象. yii\validators\EachValidator
isActive() 返回一个值, 该值指示验证器对于给定场景和属性是否处于活动状态. yii\validators\Validator
isEmpty() 检查给定值是否为空. yii\validators\Validator
off() 从该组件分离现有的事件处理程序. yii\base\Component
on() 将事件处理程序附加到事件. yii\base\Component
trigger() 触发事件. yii\base\Component
validate() 验证给定的值. yii\validators\Validator
validateAttribute() 验证单个属性. yii\validators\EachValidator
validateAttributes() 验证指定的对象. yii\validators\Validator

受保护的方法

隐藏继承的方法

方法描述定义在
formatMessage() 使用 I18N 格式化消息, 或者当\Yii::$app不可用时使用简单的strtr函数. yii\validators\Validator
validateValue() 验证一个值. yii\validators\EachValidator

属性详情

$allowMessageFromRule public 属性

如果验证失败, 是否使用通过 $rule 声明的验证器组成的错误消息.

如果启用, 则仅当属性值不是数组时, 才会显示为此验证器本身指定的错误消息.

如果禁用, 则始终使用自己的错误消息值.

$rule public 属性

验证规则的定义, 应该在数组值上使用.

它应该以与 yii\base\Model::rules() 相同的格式来指定, 除了它不应该包含属性列表作为第一个元素.

例如:

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

有关更多详细信息, 请参阅 yii\base\Model::rules().

$stopOnFirstError public 属性 (可用自版本: 2.0.11)

是否在检测到属性值元素中的第一个错误时停止验证.

启用时, 验证将在属性上生成单个错误消息; 禁用时会显示多个错误消息, 每个无效值一个.

Note: 该选项仅影响 validateAttribute() 值, 而 validateValue() 不会受到影响.

public boolean $stopOnFirstError true

方法详情

init() public 方法

初始化对象.

在使用给定的配置初始化对象之后, 在构造函数的末尾调用此方法.

public void init ( )
validateAttribute() public 方法

验证单个属性.

子类必须实现此方法才能提供实际的验证逻辑.

public void validateAttribute ( $model, $attribute )
$model yii\base\Model

要验证的数据模型.

$attribute string

要验证的属性的名称.

validateValue() protected 方法

验证一个值.

验证器类可以实现此方法以支持数据验模型的上下文中的数据验证.

protected array|null validateValue ( $value )
$value mixed

要验证的数据值.

return array|null

错误消息和要插入到错误消息中的参数数组.

if (!$valid) {
    return [$this->message, [
        'param1' => $this->param1,
        'formattedLimit' => Yii::$app->formatter->asShortSize($this->getSizeLimit()),
        'mimeTypes' => implode(', ', $this->mimeTypes),
        'param4' => 'etc...',
    ]];
}

return null;

对于这个例子, message模板可以包含{param1}, {formattedLimit}, {mimeTypes}, {param4}.

如果数据有效, 则应该返回null.

throws yii\base\NotSupportedException

如果验证器不支持没有模型的数据验证.