0 follower

入力を検証する

経験則として言えることは、エンド・ユーザから受信したデータは決して信用せず、 利用する前に検証しなければならない、ということです。

モデル にユーザの入力が投入されたら、モデルの yii\base\Model::validate() メソッドを呼んで入力を検証することが出来ます。 このメソッドは検証が成功したか否かを示す真偽値を返します。 検証が失敗した場合は、yii\base\Model::$errors プロパティからエラー・メッセージを取得することが出来ます。例えば、

$model = new \app\models\ContactForm();

// モデルの属性にユーザ入力を投入する
$model->load(\Yii::$app->request->post());
// これは次と等価
// $model->attributes = \Yii::$app->request->post('ContactForm');

if ($model->validate()) {
    // 全ての入力が有効
} else {
    // 検証が失敗。$errors はエラー・メッセージを含む配列
    $errors = $model->errors;
}

規則を宣言する

validate() を現実に動作させるためには、検証する予定の属性に対して検証規則を宣言しなければなりません。 規則は yii\base\Model::rules() メソッドをオーバーライドすることで宣言します。 次の例は、ContactForm モデルに対して検証規則を宣言する方法を示すものです。

public function rules()
{
    return [
        // 名前、メール・アドレス、主題、本文が必須項目
        [['name', 'email', 'subject', 'body'], 'required'],

        // email 属性は有効なメール・アドレスでなければならない
        ['email', 'email'],
    ];
}

rules() メソッドは規則の配列を返すべきものですが、 その配列の各要素は次の形式の配列でなければなりません。

[
    // 必須。この規則によって検証されるべき属性を指定する。
    // 属性が一つだけの場合は、属性の名前を直接に書いてもよい。
    // (配列の中に入れずに)
    ['属性1', '属性2', ...],

    // 必須。この規則のタイプを指定する。
    // クラス名、バリデータのエイリアス、または、バリデーション・メソッドの名前。
    'バリデータ',

    // オプション。この規則が適用されるべき一つまたは複数のシナリオを指定する。
    // 指定しない場合は、この規則が全てのシナリオに適用されることを意味する。
    // "except" オプションを構成して、列挙したシナリオを除く全てのシナリオに
    // この規則が適用されるべきことを指定してもよい。
    'on' => ['シナリオ1', 'シナリオ2', ...],

    // オプション。バリデータ・オブジェクトに対する追加の構成情報を指定する。
    'プロパティ1' => '値1', 'プロパティ2' => '値2', ...
]

各規則について、最低限、規則がどの属性に適用されるか、そして、規則がどのタイプであるかを指定しなければなりません。 規則のタイプは、次に挙げる形式のどれか一つを選ぶことが出来ます。

  • コア・バリデータのエイリアス。例えば、requiredindate、等々。 コア・バリデータの完全なリストは コア・バリデータ を参照してください。
  • モデル・クラス内のバリデーション・メソッドの名前、または無名関数。 詳細は、インライン・バリデータ の項を参照してください。
  • 完全修飾のバリデータ・クラス名。詳細は スタンドアロン・バリデータ の項を参照してください。

一つの規則は、一つまたは複数の属性を検証するために使用することが出来ます。そして、一つの属性は、一つまたは複数の規則によって検証され得ます。 on オプションを指定することで、規則を特定の シナリオ においてのみ適用することが出来ます。 on オプションを指定しない場合は、規則が全てのシナリオに適用されることになります。

validate() メソッドが呼ばれると、次のステップを踏んで検証が実行されます。

  1. 現在の シナリオ を使って yii\base\Model::scenarios() から属性のリストを取得し、どの属性が検証されるべきかを決定します。 検証されるべき属性が アクティブな属性 と呼ばれます。
  2. 現在の シナリオ を使って yii\base\Model::rules() から規則のリストを取得し、どの検証規則が使用されるべきかを決定します。 使用されるべき規則が アクティブな規則 と呼ばれます。
  3. 全てのアクティブな規則を一つずつ使って、その規則に関連付けられた全てのアクティブな属性を一つずつ検証します。 検証規則はリストに挙げられている順に評価されます。

属性は、上記の検証のステップに従って、scenarios() でアクティブな属性であると宣言されており、 かつ、rules() で宣言された一つまたは複数のアクティブな規則と関連付けられている場合に、 また、その場合に限って、検証されます。

補足: 規則に名前を付けると便利です。すなわち、

public function rules()
{
    return [
        // ...
        'password' => [['password'], 'string', 'max' => 60],
    ];
}

これを子のモデルで使うことが出来ます。

public function rules()
{
    $rules = parent::rules();
    unset($rules['password']);
    return $rules;
}

エラー・メッセージをカスタマイズする

たいていのバリデータはデフォルトのエラー・メッセージを持っていて、属性の検証が失敗した場合にそれを検証の対象であるモデルに追加します。 例えば、required バリデータは、このバリデータを使って username 属性を検証したとき、 規則に合致しない場合は「ユーザ名は空ではいけません。」というエラー・メッセージをモデルに追加します。

規則のエラー・メッセージは、次に示すように、規則を宣言するときに message プロパティを指定することによってカスタマイズすることが出来ます。

public function rules()
{
    return [
        ['username', 'required', 'message' => 'ユーザ名を選んでください。'],
    ];
}

バリデータの中には、検証を失敗させたさまざまな原因をより詳しく説明するための追加のエラー・メッセージをサポートしているものがあります。 例えば、number バリデータは、検証される値が大きすぎたり小さすぎたりしたときに、 検証の失敗を説明するために、それぞれ、tooBig および tooSmall のメッセージをサポートしています。 これらのエラー・メッセージも、バリデータの他のプロパティと同様、検証規則の中で構成することが出来ます。

検証のイベント

yii\base\Model::validate() は、呼び出されると、 検証のプロセスをカスタマイズするためにオーバーライドできる二つのメソッドを呼び出します。

  • yii\base\Model::beforeValidate(): デフォルトの実装は yii\base\Model::EVENT_BEFORE_VALIDATE イベントをトリガするものです。 このメソッドをオーバーライドするか、または、イベントに反応して、検証が実行される前に、 何らかの前処理 (例えば入力されたデータの正規化) をすることが出来ます。 このメソッドは、検証を続行すべきか否かを示す真偽値を返さなくてはなりません。
  • yii\base\Model::afterValidate(): デフォルトの実装は yii\base\Model::EVENT_AFTER_VALIDATE イベントをトリガするものです。 このメソッドをオーバーライドするか、または、イベントに反応して、検証が完了した後に、 何らかの後処理をすることが出来ます。

条件付きの検証

特定の条件が満たされる場合に限って属性を検証したい場合、例えば、ある属性の検証が他の属性の値に依存する場合には、 when プロパティを使って、そのような条件を定義することが出来ます。 例えば、

    ['state', 'required', 'when' => function($model) {
        return $model->country == 'USA';
    }],

when プロパティは、次のシグニチャを持つ PHP コーラブルを値として取ります。

/**
 * @param Model $model 検証されるモデル
 * @param string $attribute 検証される属性
 * @return bool 規則が適用されるか否か
 */
function ($model, $attribute)

クライアント・サイドでも条件付きの検証をサポートする必要がある場合は、whenClient プロパティを構成しなければなりません。 このプロパティは、規則を適用すべきか否かを返す JavaScript 関数を表す文字列を値として取ります。 例えば、

    ['state', 'required', 'when' => function ($model) {
        return $model->country == 'USA';
    }, 'whenClient' => "function (attribute, value) {
        return $('#country').val() == 'USA';
    }"]

データのフィルタリング

ユーザ入力をフィルタまたは前処理する必要があることがよくあります。 例えば、username の入力値の前後にある空白を除去したいというような場合です。この目的を達するために検証規則を使うことが出来ます。

次の例では、入力値の前後にある空白を除去して、空の入力値を null に変換することを、 trim および default のコア・バリデータで行っています。

return [
    [['username', 'email'], 'trim'],
    [['username', 'email'], 'default'],
];

もっと汎用的な filter バリデータを使って、 もっと複雑なデータ・フィルタリングをすることも出来ます。

お分かりのように、これらの検証規則は実際には入力を検証しません。 そうではなくて、検証される属性の値を処理して書き戻すのです。

ユーザ入力の完全な処理を次のサンプル・コードで示します。 これは、ある属性に整数の値だけが保存されるように保証しようとするものです。

['age', 'trim'],
['age', 'default', 'value' => null],
['age', 'integer', 'min' => 0],
['age', 'filter', 'filter' => 'intval', 'skipOnEmpty' => true],

上記のコードは入力に対して以下の操作を実行します。

  1. 入力値から先頭と末尾のホワイト・スペースをトリムします。
  2. 空の入力値がデータベースで null として保存されることを保証します。 "not set(未設定)" という値と、実際の値である 0 は区別します。null が許されない時は、ここで別のデフォルト値を設定することが出来ます。
  3. 空でない場合は、値は 0 以上の整数であることを検証します。 通常のバリデータでは $skipOnEmptytrue に設定されています。
  4. 例えば、文字列 '42' は、整数 42 にキャストして、値が整数型になることを保証します。 デフォルトでは false である filter バリデータの $skipOnEmptytrue に設定しています。

空の入力値を扱う

HTML フォームから入力データが送信されたとき、入力値が空である場合には何らかのデフォルト値を割り当てなければならないことがよくあります。 default バリデータを使ってそうすることが出来ます。例えば、

return [
    // 空の時は "username" と "email" を null にする
    [['username', 'email'], 'default'],

    // 空の時は "level" を 1 にする
    ['level', 'default', 'value' => 1],
];

デフォルトでは、入力値が空であると見なされるのは、それが、空文字列であるか、空配列であるか、null であるときです。 空を検知するこのデフォルトのロジックは、yii\validators\Validator::isEmpty() プロパティを PHP コーラブルで構成することによって、 カスタマイズすることが出来ます。例えば、

    ['agree', 'required', 'isEmpty' => function ($value) {
        return empty($value);
    }]

補足: たいていのバリデータは、yii\validators\Validator::$skipOnEmpty プロパティがデフォルト値 true を取っている場合は、 空の入力値を処理しません。そのようなバリデータは、関連付けられた属性が空の入力値を受け取ったときは、 検証の過程ではスキップされるだけになります。コア・バリデータ の中では、 captchadefaultfilterrequired、そして trim だけが空の入力値を処理します。

その場限りの検証

時として、何らかのモデルに結び付けられていない値に対する その場限りの検証 を実行しなければならない場合があります。

実行する必要がある検証が一種類 (例えば、メール・アドレスの検証) だけである場合は、 使いたいバリデータの validate() メソッドを次のように呼び出すことが出来ます。

$email = 'test@example.com';
$validator = new yii\validators\EmailValidator();

if ($validator->validate($email, $error)) {
    echo 'メール・アドレスは有効。';
} else {
    echo $error;
}

補足: 全てのバリデータがこの種の検証をサポートしている訳ではありません。 その一例が unique コア・バリデータであり、これはモデルとともに使用されることだけを前提にして設計されています。

補足: yii\base\Validator::skipOnEmpty プロパティは yii\base\Model の検証の場合にのみ使用されます。モデル無しで使っても効果はありません。

いくつかの値に対して複数の検証を実行する必要がある場合は、属性と規則の両方をその場で宣言することが出来る yii\base\DynamicModel を使うことが出来ます。 これは、次のような使い方をします。

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

    if ($model->hasErrors()) {
        // 検証が失敗
    } else {
        // 検証が成功
    }
}

yii\base\DynamicModel::validateData() メソッドは DynamicModel のインスタンスを作成し、 与えられた値 (この例では nameemail) を使って属性を定義し、そして、与えられた規則で yii\base\Model::validate() を呼び出します。

別の選択肢として、次のように、もっと「クラシック」な構文を使って、その場限りのデータ検証を実行することも出来ます。

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 {
        // 検証が成功
    }
}

検証を実行した後は、通常のモデルで行うのと同様に、検証が成功したか否かを hasErrors() メソッドを呼んでチェックして、 errors プロパティから検証エラーを取得することが出来ます。 また、このモデルのインスタンスによって定義された動的な属性に対しても、例えば $model->name$model->email のようにして、アクセスすることが出来ます。

バリデータを作成する

Yii のリリースに含まれている コア・バリデータ を使う以外に、あなた自身のバリデータを作成することも出来ます。 インライン・バリデータとスタンドアロン・バリデータを作ることが出来ます。

インライン・バリデータ

インライン・バリデータは、モデルのメソッドまたは無名関数として定義されるバリデータです。 メソッド/関数 のシグニチャは、

/**
 * @param string $attribute 現在検証されている属性
 * @param mixed $params 規則に与えられる "params" の値
 * @param \yii\validators\InlineValidator $validator 関係する InlineValidator のインスタンス。
 * このパラメータは、バージョン 2.0.11 以降で利用可能。
 */
function ($attribute, $params, $validator)

属性が検証に失敗した場合は、メソッド/関数 は yii\base\Model::addError() を呼んでエラー・メッセージをモデルに保存し、 後で読み出してエンド・ユーザに表示することが出来るようにしなければなりません。

下記にいくつかの例を示します。

use yii\base\Model;

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

    public function rules()
    {
        return [
            // モデル・メソッド validateCountry() として定義されるインライン・バリデータ
            ['country', 'validateCountry'],

            // 無名関数として定義されるインライン・バリデータ
            ['token', function ($attribute, $params, $validator) {
                if (!ctype_alnum($this->$attribute)) {
                    $this->addError($attribute, 'トークンは英数字で構成しなければなりません。');
                }
            }],
        ];
    }

    public function validateCountry($attribute, $params, $validator)
    {
        if (!in_array($this->$attribute, ['USA', 'Indonesia'])) {
            $this->addError($attribute, '国は "USA" または "Indonesia" でなければなりません。');
        }
    }
}

補足: バージョン 2.0.11 以降では、代わりに、yii\validators\InlineValidator::addError() を使ってエラー・メッセージを追加することが出来ます。 そうすれば、エラー・メッセージはそのまま yii\i18n\I18N::format() を使ってフォーマットされます。 属性のラベルと値を参照するためには、それぞれ、{attribute}{value} を使ってください(手作業で取得する必要はありません)。

$validator->addError($this, $attribute, 'The value "{value}" is not acceptable for {attribute}.');

補足: デフォルトでは、インライン・バリデータは、関連付けられている属性が空の入力値を受け取ったり、 既に何らかの検証規則に失敗したりしている場合には、適用されません。規則が常に適用されることを保証したい場合は、 規則の宣言において skipOnEmpty および/または skipOnError のプロパティを false に設定することが出来ます。例えば、

[
    ['country', 'validateCountry', 'skipOnEmpty' => false, 'skipOnError' => false],
]

スタンドアロン・バリデータ

スタンドアロン・バリデータは、yii\validators\Validator またはその子クラスを拡張するクラスです。 yii\validators\Validator::validateAttribute() メソッドをオーバーライドすることによって、その検証ロジックを実装することが出来ます。 インライン・バリデータ でするのと同じように、属性が検証に失敗した場合は、 yii\base\Model::addError() を呼んでエラー・メッセージをモデルに保存します。

例えば、上記のインライン・バリデータは、新しい [[components/validators/CountryValidator]] クラスに作りかえることが出来ます。 この場合、yii\validators\Validator::addError() を使って特製のメッセージをモデルに設定することが出来ます。

namespace app\components;

use yii\validators\Validator;

class CountryValidator extends Validator
{
    public function validateAttribute($model, $attribute)
    {
        if (!in_array($model->$attribute, ['USA', 'Indonesia'])) {
            $this->addError($model, $attribute, '国は "{coutry1}" または "{coutry2}" でなければなりません。', ['country1' => 'USA', 'country2' => 'Indonesia']);
        }
    }
}

あなたのバリデータで、モデルを使わない値の検証をサポートしたい場合は、yii\validators\Validator::validate() もオーバーライドしなければなりません。または、validateAttribute()validate() の代りに、 yii\validators\Validator::validateValue() をオーバーライドしても構いません。 と言うのは、前の二つは、デフォルトでは、validateValue() を呼び出すことによって実装されているからです。

次の例は、上記のバリデータ・クラスをあなたのモデルの中でどのように使用することが出来るかを示すものです。

namespace app\models;

use Yii;
use yii\base\Model;
use app\components\validators\CountryValidator;

class EntryForm extends Model
{
    public $name;
    public $email;
    public $country;

    public function rules()
    {
        return [
            [['name', 'email'], 'required'],
            ['country', CountryValidator::className()],
            ['email', 'email'],
        ];
    }
}

複数の属性の検証

時として、バリデータが複数の属性に関係する場合があります。次のようなフォームを考えてみてください。

class MigrationForm extends \yii\base\Model
{
    /**
     * 成人一人のための最低限の生活費
     */
    const MIN_ADULT_FUNDS = 3000;
    /**
     * こども一人のための最低限の生活費
     */
    const MIN_CHILD_FUNDS = 1500;

    public $personalSalary;   // 給与
    public $spouseSalary;     // 配偶者の給与
    public $childrenCount;    // こどもの数
    public $description;

    public function rules()
    {
        return [
            [['personalSalary', 'description'], 'required'],
            [['personalSalary', 'spouseSalary'], 'integer', 'min' => self::MIN_ADULT_FUNDS],
            ['childrenCount', 'integer', 'min' => 0, 'max' => 5],
            [['spouseSalary', 'childrenCount'], 'default', 'value' => 0],
            ['description', 'string'],
        ];
    }
}

バリデータを作成する

家族の収入が子ども達のために十分であるかどうかをチェックする必要があるとしましょう。 そのためには、childrenCount が 1 以上である場合にのみ実行される validateChildrenFunds というインライン・バリデータを作れば良いわけです。

検証されるすべての属性 (['personalSalary', 'spouseSalary', 'childrenCount']) にこのバリデータをアタッチすることは出来ない、ということに注意してください。 そのようにすると、同じバリデータが属性ごとに (合計で三回) 走ることになりますが、 属性のセット全体に対してこのバリデータを一度だけ走らせれば十分なのです。

これらの属性のどれを使っても構いません (あるいは、もっとも関係が深いと思うものを使ってください)。

['childrenCount', 'validateChildrenFunds', 'when' => function ($model) {
    return $model->childrenCount > 0;
}],

validateChildrenFunds の実装は次のようにすることが出来ます。

public function validateChildrenFunds($attribute, $params)
{
    $totalSalary = $this->personalSalary + $this->spouseSalary;
    // 配偶者の給与が指定されているときは、成人の最低生活費を倍にする
    $minAdultFunds = $this->spouseSalary ? self::MIN_ADULT_FUNDS * 2 : self::MIN_ADULT_FUNDS;
    $childFunds = $totalSalary - $minAdultFunds;
    if ($childFunds / $this->childrenCount < self::MIN_CHILD_FUNDS) {
        $this->addError('childrenCount', '子どもの数に対して給与が不足しています。');
    }
}

この検証は属性一つだけに関係するものではないので、$attribute のパラメータは無視することが出来ます。

エラー・メッセージを追加する

複数の属性の場合のエラー・メッセージの追加は、フォームをどのように設計するかによって異なってきます。

  • もっとも関係が深いとあなたが思うフィールドを選んで、その属性にエラー・メッセージを追加する。
$this->addError('childrenCount', '子どもの数に対して給与が不足しています。');
  • 重要な複数の属性、または、すべての属性を選んで、同じエラー・メッセージを追加する。 メッセージを独立した変数に格納してから addError に渡せば、コードを DRY に保つことが出来ます。
$message = '子どもの数に対して給与が不足しています。';
$this->addError('personalSalary', $message);
$this->addError('wifeSalary', $message);
$this->addError('childrenCount', $message);

あるいは、ループを使います。

$attributes = ['personalSalary', 'wifeSalary', 'childrenCount'];
foreach ($attributes as $attribute) {
    $this->addError($attribute, '子どもの数に対して給与が不足しています。');
}
  • (特定の属性に結び付かない) 共通のエラー・メッセージを追加する。 その時点では属性の存在はチェックされませんので、存在しない属性の名前、例えば * を使ってエラー・メッセージを追加することが出来ます。
$this->addError('*', '子どもの数に対して給与が不足しています。');

結果として、フォームのフィールドの近くにはこのエラー・メッセージは表示されません。これを表示するためには、ビューにエラー・サマリを含めます。

<?= $form->errorSummary($model) ?>

補足: 複数の属性を一度に検証するバリデータを作成する方法が community cookbook で分り易く解説されています。.

クライアント・サイドでの検証

エンド・ユーザが HTML フォームで値を入力する際には、JavaScript に基づくクライアント・サイドでの検証を提供することが望まれます。 というのは、クライアント・サイドでの検証は、ユーザが入力のエラーを早く見つけることが出来るようにすることによって、より良いユーザ体験を提供するものだからです。 あなたも、サーバ・サイドでの検証 に加えて クライアント・サイドでの検証をサポートするバリデータを使用したり実装したりすることが出来ます。

情報: クライアント・サイドでの検証は望ましいものですが、不可欠なものではありません。 その主たる目的は、ユーザにより良い体験を提供することにあります。 エンド・ユーザから来る入力値と同じように、クライアント・サイドでの検証を決して信用してはいけません。 この理由により、これまでの項で説明したように、常に yii\base\Model::validate() を呼び出してサーバ・サイドでの検証を実行しなければなりません。

クライアント・サイドでの検証を使う

多くの コア・バリデータ は、そのままで、クライアント・サイドでの検証をサポートしています。 あなたがする必要があるのは、yii\widgets\ActiveForm を使って HTML フォームを作るということだけです。 例えば、下の LoginForm は二つの規則を宣言しています。 一つは、required コア・バリデータを使っていますが、これはクライアント・サイドとサーバ・サイドの両方でサポートされています。 もう一つは validatePassword インライン・バリデータを使っていますが、こちらはサーバ・サイドでのみサポートされています。

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', 'ユーザ名またはパスワードが違います。');
        }
    }
}

次のコードによって構築される HTML フォームは、usernamepassword の二つの入力フィールドを含みます。 何も入力せずにこのフォームを送信すると、何かを入力するように要求するエラー・メッセージが、 サーバと少しも交信することなく、ただちに表示されることに気付くでしょう。

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

舞台裏では、yii\widgets\ActiveForm がモデルで宣言されている検証規則を読んで、 クライアント・サイドの検証をサポートするバリデータのために、適切な JavaScript コードを生成します。 ユーザが入力フィールドの値を変更したりフォームを送信したりすると、クライアント・サイドの検証の JavaScript が起動されます。

クライアント・サイドの検証を完全に無効にしたい場合は、yii\widgets\ActiveForm::$enableClientValidation プロパティを false に設定することが出来ます。 また、個々の入力フィールドごとにクライアント・サイドの検証を無効にしたい場合には、 入力フィールドの yii\widgets\ActiveField::$enableClientValidation プロパティを false に設定することが出来ます。 eanbleClientValidation が入力フィールドのレベルとフォームのレベルの両方で構成されている場合は前者が優先されます。

情報: バージョン 2.0.11 以降、yii\validators\Validator を拡張する全てのバリデータは、クライアント・サイドのオプションを 独立したメソッド - yii\validators\Validator::getClientOptions() から受け取るようになりました。これを使うと、次のことが可能になります。

  • 独自のクライアント・サイド検証を実装しながら、 サーバ・サイド検証のオプションとの同期はそのまま残す
  • 特殊な要求に合うように拡張またはカスタマイズする
public function getClientOptions($model, $attribute)
{
    $options = parent::getClientOptions($model, $attribute);
    // ここで $options を修正

    return $options;
}

クライアント・サイドの検証を実装する

クライアント・サイドの検証をサポートするバリデータを作成するためには、 クライアント・サイドでの検証を実行する JavaScript コードを返す yii\validators\Validator::clientValidateAttribute() メソッドを実装しなければなりません。 その JavaScript の中では、次の事前定義された変数を使用することが出来ます。

  • attribute: 検証される属性の名前。
  • value: 検証される値。
  • messages: 属性に対する検証のエラー・メッセージを保持するために使用される配列。
  • deferred: Deferred オブジェクトをプッシュして入れることが出来る配列 (次の項で説明します)。

次の例では、入力された値が既存のステータスのデータに含まれる有効なステータス値であるかどうかを検証する StatusValidator を作成します。 このバリデータは、サーバ・サイドとクライアント・サイドの両方の検証をサポートします。

namespace app\components;

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

class StatusValidator extends Validator
{
    public function init()
    {
        parent::init();
        $this->message = '無効なステータスが入力されました。';
    }

    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);
        return <<<JS
if ($.inArray(value, $statuses) === -1) {
    messages.push($message);
}
JS;
    }
}

ヒント: 上記のコード例の主たる目的は、クライアント・サイドの検証をサポートする方法を説明することにあります。 実際の仕事では、in コア・バリデータを使って、同じ目的を達することが出来ます。 次のように検証規則を書けばよいのです。

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

ヒント: クライアント・サイドの検証を手動で操作する必要がある場合、すなわち、動的にフィールドを追加したり、何か特殊な UI ロジックを実装する場合は、 Yii 2.0 Cookbook の Working with ActiveForm via JavaScript を参照してください。

Deferred 検証

非同期のクライアント・サイドの検証をサポートする必要がある場合は、Defered オブジェクト を作成することが出来ます。 例えば、AJAX によるカスタム検証を実行するために、次のコードを使うことが出来ます。

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

上のコードにおいて、deferred は Yii が提供する変数で、Deferred オブジェクトの配列です。 jQuery の $.get() メソッドによって作成された Deferred オブジェクトが deferred 配列にプッシュされています。

Deferred オブジェクトを明示的に作成して、非同期のコールバックが呼ばれたときに、Deferred オブジェクトの resolve() メソッドを呼ぶことも出来ます。 次の例は、アップロードされる画像ファイルの大きさをクライアント・サイドで検証する方法を示すものです。

public function clientValidateAttribute($model, $attribute, $view)
{
    return <<<JS
        var def = $.Deferred();
        var img = new Image();
        img.onload = function() {
            if (this.width > 150) {
                messages.push('画像の幅が大きすぎます。');
            }
            def.resolve();
        }
        var reader = new FileReader();
        reader.onloadend = function() {
            img.src = reader.result;
        }
        reader.readAsDataURL(file);

        deferred.push(def);
JS;
}

補足: 属性が検証された後に、resolve() メソッドを呼び出さなければなりません。 そうしないと、主たるフォームの検証が完了しません。

簡潔に記述できるように、deferred 配列はショートカット・メソッド add() を装備しており、このメソッドを使うと、自動的に Deferred オブジェクトを作成して deferred 配列に追加することが出来ます。このメソッドを使えば、上記の例は次のように簡潔に記すことが出来ます。

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('画像の幅が大きすぎます。');
                }
                def.resolve();
            }
            var reader = new FileReader();
            reader.onloadend = function() {
                img.src = reader.result;
            }
            reader.readAsDataURL(file);
        });
JS;
}

AJAX 検証

場合によっては、サーバだけが必要な情報を持っているために、サーバ・サイドでしか検証が実行できないことがあります。 例えば、ユーザ名がユニークであるか否かを検証するためには、サーバ・サイドで user テーブルを調べることが必要になります。 このような場合には、AJAX ベースの検証を使うことが出来ます。 AJAX 検証は、通常のクライアント・サイドでの検証と同じユーザ体験を保ちながら、入力値を検証するためにバックグラウンドで AJAX リクエストを発行します。

単一のインプット・フィールドに対して AJAX 検証を有効にするためには、そのフィールドの enableAjaxValidation プロパティを true に設定し、フォームに一意の id を指定します。

use yii\widgets\ActiveForm;

$form = ActiveForm::begin([
    'id' => 'registration-form',
]);

echo $form->field($model, 'username', ['enableAjaxValidation' => true]);

// ...

ActiveForm::end();

フォームの全てのインプットに対して AJAX 検証を有効にするためには、フォームのレベルで enableAjaxValidation を true に設定します。

$form = ActiveForm::begin([
    'id' => 'contact-form',
    'enableAjaxValidation' => true,
]);

補足: enableAjaxValidation プロパティがインプット・フィールドのレベルとフォームのレベルの両方で構成された場合は、 前者が優先されます。

また、サーバ・サイドでは、AJAX 検証のリクエストを処理できるように準備しておく必要があります。 これは、コントローラのアクションにおいて、次のようなコード断片を使用することで達成できます。

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

上記のコードは、現在のリクエストが AJAX であるかどうかをチェックします。 もし AJAX であるなら、リクエストに応えて検証を実行し、エラーを JSON 形式で返します。

情報: AJAX 検証を実行するためには、Deferred 検証 を使うことも出来ます。 しかし、ここで説明された AJAX 検証の機能の方がより体系化されており、コーディングの労力も少なくて済みます。

enableClientValidationenableAjaxValidation が両方とも true に設定されているときは、 クライアント検証が成功した後でだけ AJAX 検証のリクエストが起動されます。 validateOnChange, validateOnBlur または validateOnTypetrue に設定されている単一のフィールドを検証する場合、 当該フィールドが単独でクライアント検証を通ったら AJAX リクエストが送信されることに注意して下さい。

Found a typo or you think this page needs improvement?
Edit it on github !