Yii2 rules 自定义规则

 

Yii2 提供了一套完善的参数校验规则，但有时可能不满足实际需求，需要我们自定义规则，这里简单介绍下自定义规则的使用。

比如有个参数 country ，只能接收 'USA', 'Web'，其余校验不通过，代码如下：

public $country;

public function rules()
{
    return [
        // 自定义validateCountry()方法校验规则
        ['country', 'validateCountry'],
    ];
}

public function validateCountry($attribute, $params)
{
    if (!in_array($this->$attribute, ['USA', 'Web'])) {
        $this->addError($attribute, 'The country must be either "USA" or "Web".');
    }
}

常见问题：自定义规则失效。

按上述代码其实有个规则失效问题，当参数为空的时候或者已经在其他验证中失效的情况下，是不走validateCountry() 方法的。

这时可以加上参数 skipOnEmpty 和 skipOnError 设置为 false。

代码如下：

public $country;

public function rules()
{
    return [
        // 自定义validateCountry()方法校验规则
        ['country', 'validateCountry', 'skipOnEmpty' => false, 'skipOnError' => false],
    ];
}

public function validateCountry($attribute, $params)
{
    if (!in_array($this->$attribute, ['USA', 'Web'])) {
        $this->addError($attribute, 'The country must be either "USA" or "Web".');
    }
}