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 5.x CakePHP3

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

Message コメントをキャンセル

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

: CakePHP4のFrozenDateで1ヵ月前、先月、今月1日、来月末の日付などを算出する方法

CakePHPには「FrozenDate」の日付を扱う関数が用意されている。これを利用して、1ヶ月後、月末日、月初日、5日後などを指定して日付を取得できる。それを解説。

: CakePHP3のアソシエーションでJOINのタイプのLEFT、INNERを切り替えながら使う方法

CakePHP3でテーブルのアソシエーションしたデータの取得をコントローラー側でINNERかLEFTを指定する方法を解説。TableファイルにINNERで指定していてもController側で変更ができる。

: CakePHP4 でコマンドプログラム（シェルプログラム）を作成する方法解説

CakePHP4でバッチ処理を行うためのコマンド・シェルの実装方法について解説。bakeでテンプレートファイルを作成し、「execute()」に処理を記述する方法を解説。

: CakePHP4、5の認証処理で認証が通らない際の確認方法と確認箇所の紹介

CakePHP4、5系の認証処理でログイン認証が通らない場合の確認方法、確認箇所を解説。ログ出力し、ステータスを確認するが、ステータスの内容も紹介。それはそのままusernameを変更する際のポイントでもある。

: CakePHP3でCookieを保存、呼び出し、削除の操作・CakePHP3.7対応

CakePHP3.7でCookieを保存、取り出し、削除する方法を解説。CakePHP3でのCookieの取り扱いはバージョンごとに変更されるため、環境に合わせた方法を探す必要がある。

: CakePHP3で画像・ファイルのアップロード処理を自作・解説付き・その２

ファイルのアップロード機能の自作サンプルコードとその解説のその２。アップロード機能に関連するファイルの更新や削除の処理や画像、フォルダのパスの指定方法などを含めて解説。

: CakePHP3でテーブルにカラム（項目）を追加したときに変更するポイントのまとめ

CakePHP3でシステム開発をする際、途中でカラムを追加した場合に何を変更すればいいかを確認。カラムを追加する前後で Bakeした結果を比較し、変更になった点をリストアップした。

: CakePHP3で Ajaxを使う方法の解説。3.6以降対応。Successとthenの両方を解説。

CakePHP3でajaxを利用する処理の実装方法を解説。プルダウンを変更するとデータベースの値を取得し検索結果の内容を変更するというような処理を想定。CakePHP3.6以降の CSRF対策対応済。

: CakePHPのpostlinkで生成した削除リンクをクリックしても処理が実行されない対処法

CakePHP環境にてpostLinkで生成した削除のリンクをクリックしても処理が実行されず、JavaScriptでUncaught TypeErrorが発生。原因は同一IDを複数記述していることだった。