CakePHP3で値を入力直後にバリデーションする方法解説

CakePHP3で入力された値を入力直後にバリデーションする処理

　
CakePHP3の入力チェックは、データベースに情報を保存する際にエラー処理を行っていますが、入力された値を何かしら加工をして、それから保存する場合など、あらかじめ入力チェックをしておきたい、と思う場面もあるでしょう。
　
そういう場合に、入力直後にバリデーション（入力チェック）を行う処理も用意されていますので、その処理について解説を行います。
　
　

CakePHP3で Bakeしたデフォルトの処理

　
CakePHP3で、リンクの情報を登録する「Links」というテーブルを作成し、Bakeして作成されたデフォルトの処理が下記になります。
　

public function add()
{
    $link = $this->Links->newEntity();
    if ($this->request->is('post')) {
        $link = $this->Links->patchEntity($link, $this->request->data);
        if ($this->Links->save($link)) {
            $this->Flash->success(__('The site link has been saved.'));

            return $this->redirect(['action' => 'index']);
        } else {
            $this->Flash->error(__('The site link could not be saved. Please, try again.'));
        }
    }
    $this->set(compact('link'));
    $this->set('_serialize', ['link']);
}

CakePHP3で入力直後にバリデーションの処理を追加

　
前項の Bakeで作成されたデフォルトのプログラムに対して、6～10行目、20行目を追加することで、入力の値を受け取った直後にバリデーション処理を実施することができます。
　

public function add()
{
    $link = $this->Links->newEntity();
    if ($this->request->is('post')) {

        $link_check = $this->Links->newEntity($this->request->data);
        if ($link_check->errors()){
            // 入力エラーの処理
            $this->Flash->error(__('The site name could not be saved. Please, try again.'));
        } else {

            $link = $this->Links->patchEntity($link, $this->request->data);
            if ($this->Links->save($link)) {
                $this->Flash->success(__('The site link has been saved.'));

                return $this->redirect(['action' => 'index']);
            } else {
                $this->Flash->error(__('The site link could not be saved. Please, try again.'));
            }
        }
    }
    $this->set(compact('link'));
    $this->set('_serialize', ['link']);
}

　
「newEntity()」で取得する入力値のオブジェクトに対して、受け取った直後にバリデーション（入力チェック）を行う処理を追加しています。
　
　
[amazonjs asin=”4798048577″ locale=”JP” title=”PHPフレームワーク CakePHP 3入門”]
　

CakePHP3でのバリデーション処理の詳細解説

　
細かく説明しますと、6行目の「newEntity()」の処理で、リクエストデータを設定します。
　

$link       = $this->Links->newEntity();
                                     ↓この中に「$this->request->data」を追加
$link_check = $this->Links->newEntity($this->request->data);

　
　
7行目の「$link_check->errors()」で、バリデーション処理で発生したエラーの情報を取得し、エラーがある場合は、エラー処理を行います。
　

if ($name->errors()){
    // 入力エラーの処理
    $this->Flash->error(__('The site name could not be saved. Please, try again.'));
}

　
これにより、入力エラーがある場合は、入力画面に戻り、画面上部にエラーメッセージを表示することができるようになります。
　
　

Tableファイルにバリデーションルールを追加

　
バリデーションのルールの詳細はまた改めて記事を書く予定ですが、バリデーションのルールを追加する場合は、Tableファイルにバリデーションルールを追加します。
下記の例では 8行目に追加しています。
この場合の「not-url」は、バリデーションのルールの名称ですので、他のルール名称とかぶっていなければ、「aaa」「bbb」などでも問題ありません。
　
※LinksTable.php

public function validationDefault(Validator $validator)
{
        ：
        ：
    $validator
        ->requirePresence('url', 'create')
        ->notEmpty('url')
        ->add("url","not-url",["rule"=>"url","message"=>"Enter a valid URL"]);
//                    ↑この「not-url」はバリデーションのルールの名称
//                      他のルールとかぶらないように適当に付ければOK

バリデーションで出力されるエラー

　
最後に、「$link_check->errors()」で取得できるエラーについてです。
取得できるエラーは以下のような形となっています。
　
エラーの出力される際にどのエラー処理なのか、その出力される項目名が、前項で解説をしたバリデーションのルールの名称となります。
　

[url] => Array
    (
        [not-url] => Enter a valid URL
    )

　
　
詳細については、CakePHP3のマニュアルを参照してください。
https://book.cakephp.org/3.0/ja/core-libraries/validation.html#id13
　
　
ちなみに、ほぼ同じ内容ですが、フォームから入力された情報を保存する前にバリデーションをする記事を書きました。こちらもあわせて参考にしてください。
CakePHP3で保存前にバリデーション結果を取得する2つの方法
　
　

CakePHP3の関連記事