yii2 验证规则集合-核心验证器

2020-07-02  本文已影响0人  顺子_aba3

https://www.yiiframework.com/doc/guide/2.0/zh-cn/tutorial-core-validators

Yii 提供一系列常用的核心验证器，位于 yii\validators 命名空间之下。 为了避免使用冗长的类名，你可以直接用别名来指定相应的核心验证器。 比如你可以用 required 别名代指 yii\validators\RequiredValidator 类：

public function rules()
{
    return [
        [['email', 'password'], 'required'],
    ];
}

[yii\validators\Validator::builtInValidators](https://www.yiiframework.com/doc/api/2.0/yii-validators-validator#builtInValidators-detail) 属性声明了所有被支持的验证器别名。

下面，我们将详细介绍每一款验证器的主要用法和属性。

boolean（布尔型）

[
    // 检查 "selected" 是否为 0 或 1，无视数据类型
    ['selected', 'boolean'],

    // 检查 "deleted" 是否为布尔类型，即 true 或 false
    ['deleted', 'boolean', 'trueValue' => true, 'falseValue' => false, 'strict' => true],
]

该验证器检查输入值是否为一个布尔值。

**注意： **因为通过 HTML 表单传递的输入数据都是字符串类型，所以一般情况下你都需要保持 strict 属性为假。

captcha（验证码）

[
    ['verificationCode', 'captcha'],
]

该验证器通常配合 yii\captcha\CaptchaAction 以及 yii\captcha\Captcha 使用，以确保某一输入与 CAPTCHA 小部件所显示的验证代码（verification code）相同。

compare（比对）

[
    // 检查 "password" 属性的值是否与 "password_repeat" 的值相同
    ['password', 'compare'],

    // 和上一个相同，只是明确指定了需要对比的属性字段
    ['password', 'compare', 'compareAttribute' => 'password_repeat'],

    // 检查年龄是否大于等于 30
    ['age', 'compare', 'compareValue' => 30, 'operator' => '>='],
]

该验证器比对两个特定输入值之间的关系 是否与 operator 属性所指定的相同。

比对日期值

比对验证器只能用来对比字符串和数字。如果你需要比对日期，有两种方式。 如果需要比对一个固定的日期值，只需要使用 date验证器并设置对应的属性 [min](https://www.yiiframework.com/doc/api/2.0/yii-validators-datevalidator#min-detail) 或 [max](https://www.yiiframework.com/doc/api/2.0/yii-validators-datevalidator#max-detail) 。 如果需要比对如表单提交的两个日期，比如一个fromDate和一个toDate项， 你可以结合比对验证器和日期验证器同时使用，如下所示：

['fromDate', 'date', 'timestampAttribute' => 'fromDate'],
['toDate', 'date', 'timestampAttribute' => 'toDate'],
['fromDate', 'compare', 'compareAttribute' => 'toDate', 'operator' => '<', 'enableClientValidation' => false],

因为验证器会按照顺序执行， 将首先验证 fromDate 和 toDate 字段是一个有效的日期值，最终将被转换成一个系统可识别的格式。 此后这两个值将使用比对验证器进行比对。 因日期验证器只提供服务端使用，当前不提供客户端验证， 故 [enableClientValidation](https://www.yiiframework.com/doc/api/2.0/yii-validators-validator#enableClientValidation-detail) 在比对验证器将同样被设置为 false 。

date（日期）

此日期 date 验证器有三种不同的使用方式：

[
    [['from_date', 'to_date'], 'date'],
    [['from_datetime', 'to_datetime'], 'datetime'],
    [['some_time'], 'time'],
]

该验证器检查输入值是否为适当格式的 date，time，或者 datetime。 另外，它还可以帮你把输入值转换为一个 UNIX 时间戳并保存到 timestampAttribute 所指定的属性里。

如果输入的值是可选的，可以设置一个 默认值验证器 来确保空值通过验证器验证后的值是 null， 否则数据库可能会保存类似 0000-00-00 的值， 或表单日期选择器会显示 1970-01-01 。

[
    [['from_date', 'to_date'], 'default', 'value' => null],
    [['from_date', 'to_date'], 'date'],
],

default（默认值）

[
    // 若 "age" 为空，则将其设为 null
    ['age', 'default', 'value' => null],

    // 若 "country" 为空，则将其设为 "USA"
    ['country', 'default', 'value' => 'USA'],

    // 若 "from" 和 "to" 为空，则分别给他们分配自今天起，3 天后和 6 天后的日期。
    [['from', 'to'], 'default', 'value' => function ($model, $attribute) {
        return date('Y-m-d', strtotime($attribute === 'to' ? '+3 days' ：'+6 days'));
    }],
]

该验证器并不进行数据验证。 而是，给为空的待测属性分配默认值。

function foo($model, $attribute) {
    // ... 计算 $value ...
    return $value;
}

**信息： **如何判断待测值是否为空， 被写在另外一个话题的 处理空输入章节。

double（双精度浮点型）

[
    // 检查 "salary" 是否为浮点数
    ['salary', 'double'],
]

该验证器检查输入值是否为双精度浮点数。等效于 number 验证器。

each（循环验证）

**信息： **此验证器自版本 2.0.4 后可用。

[
    // 检查是否每个分类编号都是一个整数
    ['categoryIDs', 'each', 'rule' => ['integer']],
]

此验证器只能验证数组格式的属性。此验证器将判断数组中的 每个 元素是否都符合验证规则。 在上面的例子中，categoryIDs 属性必须是一个数组 且每个元素将被使用 integer 验证器进行验证。

**注意： **如果被验证的值不是一个数组，将被认为验证失败， 并且返回 message 设定的错误信息。

email（电子邮件）

[
    // 检查 "email" 是否为有效的邮箱地址
    ['email', 'email'],
]

该验证器检查输入值是否为有效的邮箱地址。

exist（存在性）

[
    // a1 需要在 "a1" 属性所代表的字段内存在
    ['a1', 'exist'],

    // a1 必需存在，但检验的是 a1 的值在字段 a2 中的存在性
    ['a1', 'exist', 'targetAttribute' => 'a2'],

    // a1 和 a2 的值都需要存在，且它们都能收到错误提示
    [['a1', 'a2'], 'exist', 'targetAttribute' => ['a1', 'a2']],

    // a1 和 a2 的值都需要存在，只有 a1 能接收到错误信息
    ['a1', 'exist', 'targetAttribute' => ['a1', 'a2']],

    // 通过同时在 a2 和 a3 字段中检查 a2 和 a1 的值来确定 a1 的存在性
    ['a1', 'exist', 'targetAttribute' => ['a2', 'a1' => 'a3']],

    // a1 必需存在，若 a1 为数组，则其每个子元素都必须存在。
    ['a1', 'exist', 'allowArray' => true],

    // type_id 需要存在于 ProductType 类中定义的表中的“id”列中
    ['type_id', 'exist', 'targetClass' => ProductType::class, 'targetAttribute' => ['type_id' => 'id']],    

    // 与前一个相同，但使用已定义的关联“type”
    ['type_id', 'exist', 'targetRelation' => 'type'],
]

该验证器检查输入值是否在某表字段中存在。 它只对活动记录 类型的模型类属性起作用， 能支持对一个或多过字段的验证。

可以使用此验证器验证单个数据列或多个数据列 （如多个列不同的组合是否存在）。

file（文件）

[
    // 检查 "primaryImage" 是否为 PNG, JPG 或 GIF 格式的上传图片。
    // 文件大小必须小于  1MB
    ['primaryImage', 'file', 'extensions' => ['png', 'jpg', 'gif'], 'maxSize' => 1024*1024*1024],
]

该验证器检查输入值是否为一个有效的上传文件。

FileValidator 通常与 yii\web\UploadedFile 共同使用。 请参考 文件上传章节来了解有关文件上传与上传文件的检验的全部内容。

filter（过滤器）

[
    // trim 掉 "username" 和 "email" 输入
    [['username', 'email'], 'filter', 'filter' => 'trim', 'skipOnArray' => true],

    // 标准化 "phone" 输入
    ['phone', 'filter', 'filter' => function ($value) {
        // 在此处标准化输入的电话号码
        return $value;
    }],

    // 标准化 "phone" 使用方法 "normalizePhone"
    ['phone', 'filter', 'filter' => [$this, 'normalizePhone']],

    public function normalizePhone($value) {
        return $value;
    }
]

该验证器并不进行数据验证。而是给输入值应用一个过滤器， 并在验证后把它赋值回原属性变量。

**提示： **如果你只是想要用 trim 处理下输入值，你可以直接用 trim 验证器的。

**提示： **有许多的PHP方法结构和 filter 需要的结构一致。 比如使用类型转换方法 (intval， boolval, ...) 来确保属性为指定的类型， 你可以简单的设置这些方法名而不是重新定义一个匿名函数：

['property', 'filter', 'filter' => 'boolval'],
['property', 'filter', 'filter' => 'intval'],

image（图片）

[
    // 检查 "primaryImage" 是否为适当尺寸的有效图片
    ['primaryImage', 'image', 'extensions' => 'png, jpg',
        'minWidth' => 100, 'maxWidth' => 1000,
        'minHeight' => 100, 'maxHeight' => 1000,
    ],
]

该验证器检查输入值是否为代表有效的图片文件。它继承自 file 验证器， 并因此继承有其全部属性。除此之外， 它还支持以下为图片检验而设的额外属性：

ip（IP地址）

[
    // 检查 "ip_address" 是否为一个有效的 IPv4 或 IPv6 地址
    ['ip_address', 'ip'],

    // 检查 "ip_address" 是否为一个有效的 IPv6 地址或子网地址，
    // 被检查的值将被展开成为一个完整的 IPv6 表示方法。
    ['ip_address', 'ip', 'ipv4' => false, 'subnet' => null, 'expandIPv6' => true],

    // 检查 "ip_address" 是否为一个有效的 IPv4 或 IPv6 地址，
    // 允许地址存在一个表示非的字符 `!`
    ['ip_address', 'ip', 'negation' => true],
]

此验证器检查属性的值是否是一个有效的 IPv4/IPv6 地址或子网地址。 如果标准记法或 IPv6 扩展记法被启用，原始值将被改变。

此验证器有以下参数：

**信息： **此验证器自版本 2.0.7 后可用。

in（范围）

[
    // 检查 "level" 是否为 1、2 或 3 中的一个
    ['level', 'in', 'range' => [1, 2, 3]],
]

该验证器检查输入值是否存在于给定列表的范围之中。

integer（整数）

[
    // 检查 "age" 是否为整数
    ['age', 'integer'],
]

该验证器检查输入值是否为整形。

match（正则表达式）

[
    // 检查 "username" 是否由字母开头，且只包含单词字符
    ['username', 'match', 'pattern' => '/^[a-z]\w*$/i']
]

该验证器检查输入值是否匹配指定正则表达式。

number（数字）

[
    // 检查 "salary" 是否为数字
    ['salary', 'number'],
]

该验证器检查输入值是否为数字。他等效于 double 验证器。

required（必填）

[
    // 检查 "username" 与 "password" 是否为空
    [['username', 'password'], 'required'],
]

该验证器检查输入值是否为空，还是已经提供了。

**注意： **如何判断待测值是否为空，被写在另外一个话题的 处理空输入章节。

safe（安全）

[
    // 标记 "description" 为安全属性
    ['description', 'safe'],
]

该验证器并不进行数据验证。而是把一个属性标记为 安全属性。

string（字符串）

[
    // 检查 "username" 是否为长度 4 到 24 之间的字符串
    ['username', 'string', 'length' => [4, 24]],
]

该验证器检查输入值是否为特定长度的字符串。并检查属性的值是否为某个特定长度。

trim（译为修剪/裁边）

[
    // trim 掉 "username" 和 "email" 两侧的多余空格
    [['username', 'email'], 'trim'],
]

该验证器并不进行数据验证。而是，trim 掉输入值两侧的多余空格。 注意若该输入值为数组，那它会忽略掉该验证器。

unique（唯一性）

[
    // a1 需要在 "a1" 属性所代表的字段内唯一
    ['a1', 'unique'],

    // a1 需要唯一，但检验的是 a1 的值在字段 a2 中的唯一性
    ['a1', 'unique', 'targetAttribute' => 'a2'],

    // a1 和 a2 的组合需要唯一，且它们都能收到错误提示
    [['a1', 'a2'], 'unique', 'targetAttribute' => ['a1', 'a2']],

    // a1 和 a2 的组合需要唯一，只有 a1 能接收错误提示
    ['a1', 'unique', 'targetAttribute' => ['a1', 'a2']],

    // 通过同时在 a2 和 a3 字段中检查 a2 和 a3 的值来确定 a1 的唯一性
    ['a1', 'unique', 'targetAttribute' => ['a2', 'a1' => 'a3']],
]

该验证器检查输入值是否在某表字段中唯一。 它只对活动记录类型的模型类属性起作用， 能支持对一个或多过字段的验证。

url（网址）

[
    // 检查 "website" 是否为有效的 URL。若没有 URI 方案，
    // 则给 "website" 属性加 "http://" 前缀
    ['website', 'url', 'defaultScheme' => 'http'],
]

该验证器检查输入值是否为有效 URL。

**注意： **验证器检查 URL 结构和主机部分是否正确。 它不会检查URL的其余部分，也不是为防止XSS或任何其他攻击而设计的。请参阅 安全最佳实践 有关开发应用程序时威胁防范的更多信息的文章。

上一篇下一篇

猜你喜欢

热点阅读