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のインストールでURL rewriting……のエラーが！その解決方法解説

CakePHP3をインストールしたら URL rewriting is not properly configured.のエラーが。原因は.htaccessが有効になっていないこと。httpd.confに設定を追加すればOK。

: CakePHP3で環境変数を設定して本番環境と開発環境を分けて処理をする場合

CakePHP3で開発環境と本番環境とで違う設定ファイルを読み込ませて環境ごとに定数を切り替える方法を解説。Apacheのhttpd.confに環境変数を設定し、それを読み込み判別する。

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

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

: CakePHP3のデバッグキット（DebugKit）を強制的に有効、無効に変更する方法

CakePHP3に付属しているデバッグのためのツール、デバッグキットを強制的に有効化、無効化する方法を解説。初期設定では開発環境としてありそうなドメインの場合のみ有効になるように設定されている。

: CakePHP3、CakePHP4のdatetime型カラムの日時の扱い。秒まで表示する方法

CakePHP3の日時カラムで秒まで扱う場合はdate()、strtotime()関数ではうまくいかない。CakePHP3であらかじめ用意された「i18nFormat()」を使用する。

: Windows上のXAMPP環境のCakePHPのコマンド実行時に環境変数を指定する方法

CakePHP4のコマンド（シェル）に対して、環境変数を指定して実行する方法を解説。LinuxとWindows上のXAMPPとでは記述方法が異なるため、Windowsのsetコマンドについても詳細解説。

: CakePHP3のUpload Plugin 3.0をバリデーションなど実運用向けのカスタマイズ方法解説・その２

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその2でバリデーションなどの実用的なカスタマイズ方法を解説。