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で静的ページの作成は webrootか pagesを使う。トップページを参考に解説

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

: CakePHP4、5で$_SERVERと同じようにURIを取得する「getUri()」の紹介

PHPでサーバ情報、環境情報を取得する際は「$_SERVER」を利用するが、似たような情報をCakePHPの関数で取得する際は「getUri()」を使用する。取得出来る値は一致するものもあるが、違うものもあり便利な使い方もある。

: CakePHP4のCakeDC/Usersの Usersへの接続、バリデーションのカスタマイズ方法解説

CakeDC謹製Usersプラグインの紹介。CakePHP4で使う場合のUsersのカスタマイズとして入力項目のバリデーションの変更を、プラグインのファイルは触らずオーバーライドにより実装する方法を解説する。

: CakePHP3でComposerでインストールできないプラグイン、外部ライブラリを vendorに入れて手動で読み込む方法

CakePHP3にComposerからインストールできないプラグインやライブラリなどを利用する方法、vendorにファイルを設置し、composer.jsonを更新し、それを呼び出す方法を詳細に解説。

: CakePHP 2.3 主キー（ID）以外のキーで更新方法 updateAll

主キー（ID）以外のカラムをキーとして更新する方法、updateAllの使い方をサンプルを用いて解説します。

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

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