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

2017/02/25 2019/03/25

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']);
}

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']);
}

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()」で取得する入力値のオブジェクトに対して、受け取った直後にバリデーション（入力チェック）を行う処理を追加しています。
　
　

PHPフレームワーク CakePHP 3入門

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

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

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

$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.'));
}

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

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
    )

[url] => Array

(

[not-url] => Enter a valid URL

)

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

- CakePHP 3.x 4.x CakePHP3

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: CakePHP3のプラグイン「CakeDC/Users」を日本語化・翻訳ファイルもダウンロード可

CakePHP3のユーザ管理、ログイン認証プラグインである「CakeDC/Users」のメッセージを日本語にする手順の解説とともに、日本語の翻訳ファイルを提供。ファイルを設置すれば日本語になる！

: CakePHP 2.3　連携先のテーブルの項目で条件抽出する場合

アソシエーション（連携）している先のテーブルの項目で条件抽出する際の考え方と注意点をサンプルソースを用いて説明しています。

: CakePHP3の画像、ファイルアップロードプラグインUpload Plugin 3.0の設置解説・その１

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその1で基本的な導入方法の解説で読みながら簡単に導入が可能。

: CakePHP 2.3　デバッグキット（DebugKit）超初心者向けフォロー講座

CakePHP初心者に向けてデバッグキット（DebugKit）のインストール方法、はまりポイントを解説。

: CakePHP 2.3　Search Pluginで検索処理　その１設置方法

CakePHPの検索プラグイン Search Pluginの設置方法と基本的な検索処理の解説です。

: CakePHP3のメッセージ日本語化の設定（国際化と地域化の機能の使い方の解説）

CakePHP3の英語のメッセージを日本語化（多言語化）する手順を解説。オリジナルのメッセージを作成する方法やプログラムで文言を追加する場合の対応なども解説。

: CakePHP3のCakeDC/Usersのログイン後のリダイレクトとユーザ権限管理の設定解説

CakeDC謹製Usersプラグインの紹介。ログイン認証後にリダイレクトする先の設定方法についての解説と実運用するために必要なコツを解説。便利な仕組みも仕様の理解があって初めてうまく使いこなせる。

: CakePHP 2.3でファイルのアップロード処理を作る

CakePHPでプラグインを使わないファイルアップロード処理を解説します。簡単です。DBにファイルを格納する方法も。

: CakePHP 2.3 コマンドラインからPHPのシェル実行の方法解説

CakePHP 2.3でコマンドラインから CakePHPで記述した処理を実行する方法を解説します。

: CakePHP3でQRコードを作成、表示するライブラリ「cakePHP-QR-Code-Helper」

CakePHPでQRコードを生成するライブラリ「cakePHP-QR-Code-Helper」の紹介。GDライブラリのインストールも必要ないHelperとして提供されているため、ファイルを設置すればすぐに使用可能。