CakePHP4でcontrollerで実行したバリデーションエラーをmodelのにマージする方法

2022/07/13 2023/12/28

CakePHP4でcontrollerで実行したバリデーションエラーは「setError()」「setErrors()」でセットする

　
CakePHP4では強力なバリデーション（入力チェック）機能が用意されていますので、簡単にいろいろなバリデーションを組み込むことができます。
　
通常のバリデーションは Modelの中に記述します。
（src/Model/Table/ArticleTable.php 内の validationDefault()に記述します。）
　
ですが、この記事では、独自のバリデーションを controller内に記述する際の処理について解説します。
　
独自のバリデーションを controller内に記述し、その処理で発生したエラーを Model内のバリデーションの結果に追加して（エンティティにエラーをセットして）、まとめてバリデーションのエラーとして画面に表示したい、という場合の方法についての解説となります。
　
　
この記事は、CakePHP4について書いていますが、CakePHP3でも同様に記述することで同様の処理を行うことができます。
　
　

エラーのセットは「setError()」「setErrors()」を使う

　
エラーのセットは、下記の 16行目のように「setError()」を使用します。
　

    public function add()
    {
        $topic = $this->Topics->newEmptyEntity();
        if ($this->request->is('post')) {

            // アップロードしたファイル情報を取得
            $file = $this->request->getData("file");
            // アップロードファイルのバリデーション
            $fileResponse = $this->CheckFile($file);

            // アップロードファイルのバリデーション結果の処理
            if(!empty($fileResponse)){
                $fileError = $fileResponse["error"];

                // エラーメッセージをセット
                $topic->setError("file",[$fileError]);

            } else {
                $filePath = WWW_ROOT . "upload" . DS .  $file->getClientFilename();
                $file->moveTo($filePath);
                $topic["file"] = $filePath;
            }

            $topic = $this->Topics->patchEntity($topic, $this->request->getData());
            if ($this->Topics->save($topic)) {
                $this->Flash->success(__('The topic has been saved.'));

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

public function add()

{

$topic = $this->Topics->newEmptyEntity();

if ($this->request->is('post')) {

// アップロードしたファイル情報を取得

$file = $this->request->getData("file");

// アップロードファイルのバリデーション

$fileResponse = $this->CheckFile($file);

// アップロードファイルのバリデーション結果の処理

if(!empty($fileResponse)){

$fileError = $fileResponse["error"];

// エラーメッセージをセット

$topic->setError("file",[$fileError]);

} else {

$filePath = WWW_ROOT . "upload" . DS . $file->getClientFilename();

$file->moveTo($filePath);

$topic["file"] = $filePath;

}

$topic = $this->Topics->patchEntity($topic, $this->request->getData());

if ($this->Topics->save($topic)) {

$this->Flash->success(__('The topic has been saved.'));

return $this->redirect(['action' => 'index']);

}

$this->Flash->error(__('The topic could not be saved. Please, try again.'));

}

$this->set(compact('topic'));

}

　
上記は「Topics」というテーブルにファイルをアップロードする処理があり、そのアップロードしたファイルのバリデーションを controller（内にある関数）で実行し、エラーが発生したら「setError()」を使用して、エラーメッセージをセットする、という処理です。
　
9行目でアップロードしたファイルをチェックする独自のバリデーション関数「$this->CheckFile()」を使ってバリデーションを行います。
12行目でエラーの有無をチェックして、エラーが発生した場合は、16行目の「setError()」にメッセージをセットしています。
　
　

　
セットされたエラーメッセージは上記のような感じで、Modelのバリデーションと同じように表示されます。
　
　

「setError()」と「setErrors()」の使い方

　
controllerの処理で確認したエラーをエンティティにセットするには「setError()」と「setErrors()」を使用します。
　
「setError()」と「setErrors()」の違いは下記のようになっています。
　
　「setError()」は 1つのフィールドのエラーを記述
　「setErrors()」は、複数のフィールのエラーをまとめて記述
　
　

「setError()」の使い方

　
「setError()」の使い方は下記のようになります。
　

$topic->setError("フィールド名",["エラーメッセージ1","エラーメッセージ2"]);

1	$topic->setError("フィールド名",["エラーメッセージ1","エラーメッセージ2"]);

　
1つめのパラメータに「フィールド名」を記述し、2つ目のパラメータに「エラーメッセージ」を「配列」で記述します。
エラーメッセージは配列で指定しますので、エラーメッセージが複数ある場合は配列で指定すれば OKです。
　
Model側の処理でもバリデーションは実行され、発生したエラーは追加されますので、Model内と controller内と区別されることなく、入力画面にエラーメッセージが表示されます。
　
　

「setErrors()」の使い方

　
「setErrors()」の使い方は下記のようになります。
　

$topic->setErrors([
    "フィールド名1" => ["エラーメッセージ1-1","エラーメッセージ1-2"],
    "フィールド名2" => ["エラーメッセージ2-1","エラーメッセージ2-2"]
]);

$topic->setErrors([

"フィールド名1" => ["エラーメッセージ1-1","エラーメッセージ1-2"],

"フィールド名2" => ["エラーメッセージ2-1","エラーメッセージ2-2"]

]);

　
「setError()」とほとんど同じですが、複数のフィールドのエラーをまとめて記述することができるようになっています。
　
　

参考資料

　
この記事を書く際に参考にしたオフィシャルの Cookbookの URLを記載しておきます。
　
https://book.cakephp.org/3/ja/orm/entities.html#id8
https://book.cakephp.org/4/ja/orm/entities.html#id8
https://api.cakephp.org/4.1/class-Cake.ORM.Entity.html
　
　

- CakePHP 3.x 4.x 5.x CakePHP4

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

Message コメントをキャンセル

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

: cakephp3 カスタムバリデーションを簡易的に実装する方法

CakePHP3の独自のバリデーションをテーブルクラス内に簡単に記述する方法を解説。他のテーブルクラスでは使えないが、記述する量は少なく実装できるため、他で使わない処理を書くのには便利。

: CakePHPで Auto Incrementを外すと Duplicate entry ‘0’ for keyのエラーが出るかも

CakePHPでAuto Incrementの設定を変更したときに「Duplicate entry ‘0’ for key」のエラーが出た。原因はModel内で IDを編集する処理の追加を忘れていたからだった。

: CakePHP 2.3　Search Pluginで検索処理　その２表示件数を動的に変える方法

CakePHPの検索プラグイン Search Pluginの検索処理の中で動的に表示件数を変える方法です。

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

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

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

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

: CakePHP 2.3でファイルをアップロード・その2　ファイル名を乱数で設定

CakePHPのアップロードするファイル名を乱数で変更しセキュリティを高める方法を解説。

: CakePHP3で静的ページの作成は webrootか pagesを使う。トップページを参考に解説

CakePHP3で静的なページを設置する場合の方法（webrootとpagesとを活用する方法）を解説。pagesの解説はデフォルトのトップページがどう表示されているかを参考に解説。ルーティングの機能も。

: CakePHP4、5でSELECT telephone as tel FROM usersの様にasでカラムに別名を付ける方法

CakePHP4、CakePHP5でクリエビルダーを利用してテーブルからレコードを取得する際、asを使用してカラムの別名で値を取得したい場合の対応方法を解説。また、別名にはハイフンやアスタリスクなど使用できない文字がある点も解説。

: MySQL＋CakePHPのdate型、datetime型項目は「2999-12-31」までしか扱えない

CakePHPの日付、日時の型であるdate型、datetime型の最大値は2999-12-31となっている。MySQLは9999年までなので違いがあるので注意が必要だ。

: MySQL、CakePHP 2.3で「tinyint(1)」の Boolean型の動作を再確認

MySQL＋CakePHPの環境で「tinyint(1)」を利用する際の動作を検証。「tinyint(1)」の Boolean型について CakePHPでは自動処理が実施されていることを確認しました。