Yii学习笔记之四（表单验证 api 翻译）

假设须要对多个值运行多个验证，您能够使用
 yii\base\DynamicModel 能够同一时候声明属性 和 规则. 使用方式例如以下:

<?
php

public function actionSearch($name, $email)
{
    $model = DynamicModel::validateData(compact('name', 'email'), [
        [['name', 'email'], 'string', 'max' => 128],
        ['email', 'email'],
    ]);

    if ($model->hasErrors()) {
        // 验证失败代码
    } else {
        // 验证成功代码
    }
}

?>

<?php
public function actionSearch($name, $email)
{
    $model = new DynamicModel(compact('name', 'email'));
    $model->addRule(['name', 'email'], 'string', ['max' => 128])
        ->addRule('email', 'email')
        ->validate();

    if ($model->hasErrors()) {
        // 验证失败代码
    } else {
        // 验证成功代码
    }
}

?>

比如, $model->name 和 $model->email.

10. 创建验证器

除了使用包括在Yii公布的 core validators 外, 你也能够创建自己的验证器. 你能够创建一个 内联 validators 独立 validators.

(1) Inline Validators（内置验证器）

一个 inline validator 是一个 model method 或一个匿名 function. 改 method/function 的原型是:

<?php
/**
 * @param string $attribute 当前被验证的属性
 * @param mixed $params 规则里给定的參数
 */
function ($attribute, $params)
?
>

<?
php
use yii\base\Model;

class MyForm extends Model
{
    public $country;
    public $token;

    public function rules()
    {
        return [
            // 一个 inline validator 定义作为一个 model 方法 validateCountry()
            ['country', 'validateCountry'],

            // 一个 inline validator 定义作为一个匿名 function
            ['token', function ($attribute, $params) {
                if (!ctype_alnum($this->$attribute)) { ////推断是否是字母和数字或字母数字的组合
                    $this->addError($attribute, 'The token must contain letters or digits.');
                }
            }],
        ];
    }

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

比如:

<?
php
[
    ['country', 'validateCountry', 'skipOnEmpty' => false, 'skipOnError' => false],
]
?
>

(2) Standalone Validators (单独验证器)
一个 standalone validator 是一个类扩展
yii\validators\Validator 或者是他的子类

你能够实现他的验证逻辑通过重写
yii\validators\Validator::validateAttribute() 方法.

假设一个属性验证失败, 调用
yii\base\Model::addError()
去保存错误信息在 model 里, 就像上面 的 inline validators 所做的. 比如,

<?
php

namespace app\components;

use yii\validators\Validator;

class CountryValidator extends Validator
{
    public function validateAttribute($model, $attribute)
    {
        if (!in_array($model->$attribute, ['USA', 'Web'])) {
            $this->addError($model, $attribute, 'The country must be either "USA" or "Web".');
        }
    }
}

?>

11. client验证

client验证基于 JavaScript .

Info:  yii\base\Model::validate(),
使用  yii\widgets\ActiveForm 创建你的 HTML forms.
比如, LoginForm 须要声明两条规则:
      A. 必填 required; 既支持client 又支持服务端
      B. password验证 validatePassword 使用 inline validator 仅仅支持服务端

<?php
namespace app\models;

use yii\base\Model;
use app\models\User;

class LoginForm extends Model
{
    public $username;
    public $password;

    public function rules()
    {
        return [
            // username 和 password 都不能为空
            [['username', 'password'], 'required'],

            // password 通过 validatePassword() 验证
            ['password', 'validatePassword'],
        ];
    }

    public function validatePassword()
    {
        $user = User::findByUsername($this->username);

        if (!$user || !$user->validatePassword($this->password)) {
            $this->addError('password', 'Incorrect username or password.');
        }
    }
}
?>

<?php $form = yii\widgets\ActiveForm::begin(); ?>
    <?= $form->field($model, 'username') ?
>
    <?
= $form->field($model, 'password')->passwordInput() ?>
    <?
= Html::submitButton('Login') ?>
<?php yii\widgets\ActiveForm::end(); ?>

<?php
namespace app\components;

use yii\validators\Validator;
use app\models\Status;

class StatusValidator extends Validator
{
    public function init()
    {
        parent::init();
        $this->message = 'Invalid status input.';
    }

    public function validateAttribute($model, $attribute)
    {
        $value = $model->$attribute;
        if (!Status::find()->where(['id' => $value])->exists()) {
            $model->addError($attribute, $this->message);
        }
    }

    public function clientValidateAttribute($model, $attribute, $view)
    {
        $statuses = json_encode(Status::find()->select('id')->asArray()->column());
        $message = json_encode($this->message, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
        //返回js代码
		return <<<JS
if (!$.inArray(value, $statuses)) {
    messages.push($message);
}
JS;
    }
}

?>

<?php
[
    ['status', 'in', 'range' => Status::find()->select('id')->asArray()->column()],
]

?>

12. 延迟验证

假设你须要运行一个client异步验证, 你能够创建一个延迟对象集. 比如, 去运行一个 AJAX 验证, 你能够使用以下的代码:

<?
php
public function clientValidateAttribute($model, $attribute, $view)
{
    return <<<JS
        deferred.push($.get("/check", {value: value}).done(function(data) {
            if ('' !== data) {
                messages.push(data);
            }
        }));
JS;
}

?>

<?php
public function clientValidateAttribute($model, $attribute, $view)
{
    return <<<JS
        var def = $.Deferred();
        var img = new Image();
        img.onload = function() {
            if (this.width > 150) {
                messages.push('Image too wide!!');
            }
            def.resolve();
        }
        var reader = new FileReader();
        reader.onloadend = function() {
            img.src = reader.result;
        }
        reader.readAsDataURL(file);

        deferred.push(def);
JS;
}

?>

<?php
public function clientValidateAttribute($model, $attribute, $view)
{
    return <<<JS
        deferred.add(function(def) {
            var img = new Image();
            img.onload = function() {
                if (this.width > 150) {
                    messages.push('Image too wide!!');
                }
                def.resolve();
            }
            var reader = new FileReader();
            reader.onloadend = function() {
                img.src = reader.result;
            }
            reader.readAsDataURL(file);
        });
JS;
}

?
>

13. AJAX 验证

去启用 AJAX 为整个form, 你不得不设置
yii\widgets\ActiveForm::$enableAjaxValidation 属性值为 true
并且要指定id 成为一个唯一的 form 定义:

<?
php $form = yii\widgets\ActiveForm::begin([
    'id' => 'contact-form',
    'enableAjaxValidation' => true,
]); ?
>

这能够通过一个代码段像在控制器动作下面来实现:

<?php
if (Yii::$app->request->isAjax && $model->load(Yii::$app->request->post())) {
    Yii::$app->response->format = Response::FORMAT_JSON;
    return ActiveForm::validate($model);
}

?>