CakePHP4でcontrollerで実行したバリデーションエラーをmodelのにマージする方法
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'));
}
上記は「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つめのパラメータに「フィールド名」を記述し、2つ目のパラメータに「エラーメッセージ」を「配列」で記述します。
エラーメッセージは配列で指定しますので、エラーメッセージが複数ある場合は配列で指定すれば OKです。
Model側の処理でもバリデーションは実行され、発生したエラーは追加されますので、Model内と controller内と区別されることなく、入力画面にエラーメッセージが表示されます。
「setErrors()」の使い方
「setErrors()」の使い方は下記のようになります。
$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
CakePHP4の関連記事
CakePHPのpostlinkで生成した削除リンクをクリックしても処理が実行されない対処法CakePHP4系でJSONレスポンスの処理ではwithStringBodyを使う。3との違い解説
CakePHP4、CakePHP5の「warning: DebugKit is disabling...」の対処方法
MySQL+CakePHPのdate型、datetime型項目は「2999-12-31」までしか扱えない
CakePHP4のFrozenDateで1ヵ月前、先月、今月1日、来月末の日付などを算出する方法
CakePHP4のcake cache clear_allでPermission deniedはパーミッションの変更が必要
CakePHP4のクリエビルダーを使用してOR条件をAND条件でつなぐSQL文を作る方法
CakePHP4のController内でViewテンプレート、レイアウトの変更設定を記述する方法
CakePHP4から外部のデータベースにアクセスする方法解説
CakePHP4の数値項目は「like %10%」の部分一致検索(find select)はできない
その他の「CakePHP4」に関する記事一覧
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです!
関連記事
-
-
CakePHP 2.3 Search Pluginで検索処理 その1設置方法
CakePHPの検索プラグイン Search Pluginの設置方法と基本的な検索処理の解説です。
-
-
CakePHP3、CakePHP4のキャッシュをクリアする方法「bin/cake cache clear_all」を使う
CakePHP3、CakePHP4では処理を高速化する手法の一つとしてキャッシュを利用している。しかし、その情報は元の情報を更新しても反映されない場合がある。そんなときはキャッシュを削除する必要がある。
-
-
CakePHP4、CakePHP5の「warning: DebugKit is disabling...」の対処方法
CakePHPのデバッグ用のツールであるDebugKitは適切な設定をしないとエラーログにワーニングメッセージが出力される。それを解消する方法を解説。
-
-
CakePHPのpostlinkで生成した削除リンクをクリックしても処理が実行されない対処法
CakePHP環境にてpostLinkで生成した削除のリンクをクリックしても処理が実行されず、JavaScriptでUncaught TypeErrorが発生。原因は同一IDを複数記述していることだった。
-
-
CakePHP4のCSS、JavaScript、画像のブラウザへのキャッシュをコントロールする
CakePHP4、CakePHP3でブラウザにキャッシュさせる設定の解説。CSS、JavaScript、画像をブラウザにキャッシュさせるのか、定期的にリロードする設定にするのかの設定が可能。
-
-
CakePHP3でレコードを保存(追加、更新、Insert、Update)する複数の方法を紹介
CakePHP3でレコードを追加、更新(Insert、Update)する記述方法を解説。1件ずつ処理、全件をまとめて処理、条件に該当する複数件のレコードを処理方法をサンプルコードを用いて解説。
-
-
CakePHP4のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説
CakePHP4のユーザ管理プラグイン Usersは、ユーザ登録、メール認証、ログイン認証、ユーザ管理、権限管理、reCAPTCHAなど会員制のサイトを簡単に実現可能。その導入方法、カスタマイズ方法を解説。
-
-
CakePHP4 でコマンドプログラム(シェルプログラム)を作成する方法解説
CakePHP4でバッチ処理を行うためのコマンド・シェルの実装方法について解説。bakeでテンプレートファイルを作成し、「execute()」に処理を記述する方法を解説。
-
-
CakePHP4のFrozenDateで1ヵ月前、先月、今月1日、来月末の日付などを算出する方法
CakePHPには「FrozenDate」の日付を扱う関数が用意されている。これを利用して、1ヶ月後、月末日、月初日、5日後などを指定して日付を取得できる。それを解説。
-
-
CakePHP3の更新画面でUpload Plugin 3.0を使う方法、viewで使う方法解説・その3
CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその3で記事を更新する際のファイルの取り回しなどについてを解説。
