CakePHPのFlashエラーは出るが入力項目ごとのメッセージが出ないエラーの原因

2024/01/21

CakePHP4で画面上部のフラッシュメッセージと入力ボックスに表示されるエラーメッセージ

　
Bakeで自動生成された Edit処理のソースを元に、少しだけ処理を追加したところ、入力エラーが発生しているのに、バリデーションのメッセージ（入力エラー）が表示されない、と言う不具合がありました。
　

　
上記の画像の「Flashメッセージ」は表示されるのですが、「バリデーションのメッセージ」が表示されないのです。
　
　
今回のこの不具合は、バリデーションエラー（入力チェックのエラー）は発生しているものの、正常な処理によるエラー処理のため（エラーログ等は出力されないため）、不具合の原因の特定に時間がかかったのですが、同じような不具合で悩んでいる方もあるのではないか、と思い記事を書きました。
　
原因は「エラーが発生しているときにリダイレクトしているため」でした。
　
　
この記事の内容は、CakePHP3、CakePHP4でも同じように処理できます。
　
ちなみに、フラッシュエラーに関しては下記にも記事を書いていますので、参考にしてください。
CakePHP4のフラッシュメッセージの表示場所、デザインを変更する方法を解説
　
CakePHP3　フラッシュ（FlashComponent）
https://book.cakephp.org/3/ja/controllers/components/flash.html
　
CakePHP4　フラッシュ（FlashComponent）
https://book.cakephp.org/4/ja/controllers/components/flash.html
　
　

エラーが発生したときの処理でリダイレクトをしていませんか？

　
CakePHP4の入力フォームで、バリデーションエラー（入力エラー）がある場合、画面上部に表示される Flashのエラーメッセージは表示されるものの、入力エラーがある項目の下にエラーメッセージは表示されない、という不具合の一つの原因をご紹介します。
　

　
今回の記事は、上記の不具合の原因の一例のご紹介です。
プログラムの文法には不具合はないため、原因が分かりにくいものです。
　
　
不具合の原因は多種多様です。
ですが、この記事で紹介したような不具合もあるよ！これで解決する方が一人でもいれば！という感じで書いています。
　
　

Bakeで自動生成されるデフォルトのソースコードを元に解説

　
下記は Bakeで自動生成されたソースコードの一部です。
　

  public function edit($id = null)
  {
    $topic = $this->Topics->get($id, [
      'contain' => [],
    ]);
    if ($this->request->is(['patch', 'post', 'put'])) {
      $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 edit($id = null)

{

$topic = $this->Topics->get($id, [

'contain' => [],

]);

if ($this->request->is(['patch', 'post', 'put'])) {

$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'));

}

　
入力エラーが発生すると
$this->Flash->error(__('The topic could not be saved. Please, try again.'));
の処理が実行されます。
　
ここで処理されたメッセージは、レイアウト「/templates/layout/default.php」に記述されている
Flash->render() ?>
で処理されて表示されます。
　
あわせて、入力項目の
echo $this->Form->control('topics_date');
で処理されて、バリデーションエラー（入力エラー）のメッセージが入力項目の下に表示されます。
　
　

デフォルトのソースコードを元に改変したソースコード

　
今回の不具合は、デフォルトの処理を少し改変し、ログを保存する処理を追加して下記のような処理にしていました。
　
この場合、バリデーションエラー（入力エラー）があった場合、Flashのメッセージは表示されるのですが、入力項目ごとのエラーメッセージは表示されません。
　
どこが間違っているか分かりますか？
　

    try {
      $topic = $this->Topics->patchEntity($topic, $this->request->getData());
      if ($this->Topics->save($topic)) {
        // ログを保存する
        $response = $this->Common->saveLog($topic);
        if(!$response){
          throw new \Exception(__('The topic log could not be saved. Please, try again.'));
        }
      } else {
        throw new \Exception(__('The topic could not be saved. Please, try again.'));
      } 
        $this->Flash->success(__('The topic has been saved.'));
        return $this->redirect(['action' => 'index']);
      }
    } catch (\Exception $e) {
      $this->Flash->error(__($e->getMessage()));
      return $this->redirect(['action' => 'edit', $id]);
    }

try {

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

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

// ログを保存する

$response = $this->Common->saveLog($topic);

if(!$response){

throw new \Exception(__('The topic log could not be saved. Please, try again.'));

}

} else {

throw new \Exception(__('The topic could not be saved. Please, try again.'));

}

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

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

}

} catch (\Exception $e) {

$this->Flash->error(__($e->getMessage()));

return $this->redirect(['action' => 'edit', $id]);

}

　
不具合の原因は、17行目の「return $this->redirect(['action' => 'edit', $id]);」の部分になります。
　

　
上記の処理では、バリデーションエラーが発生した場合は 17行目でリダイレクトをしていますので、表示されている画面は、入力をする前の状態の画面が再度表示されているだけですので、入力項目ごとのエラーメッセージは表示されません。
　
　
ですが、16行目の「$this->Flash->error(__($e->getMessage()));」で処理している Flashメッセージに関しては、リダイレクトをしてもメッセージを受け取って表示をしてくれるのです。
　
これはこれで便利な機能なんですが、今回のような不具合の原因につながるのです。
　
　
処理の内容を確認すれば当たり前と言えば当たり前なんですが、Flashのエラーメッセージは表示されているため、リダイレクトされていることに気づきにくいんですよね。
　
処理は正しく行われており、バリデーションのエラーメッセージが表示されていない、
という不具合だと誤認してしまうのです。
そうするとなかなか不具合の原因に行き当たらないわけです。
　
　
プログラムの不具合はないけれど、入力項目ごとのエラーメッセージが表示されない。
そんな不具合が発生したときに原因に気づくきっかけになれば、と思っています。
　
　

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

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

Message コメントをキャンセル

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

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

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

: 国際化と地域化の翻訳機能「__()」を使って定数に変数を埋め込む方法

CakePHP4で定数に変数を埋め込み、翻訳機能「__()」で変数に値を入れる方法を紹介。定型の文章の一部だけを置換したい場合に利用すると便利。

: CakePHP4のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説

CakePHP4のユーザ管理プラグイン Usersは、ユーザ登録、メール認証、ログイン認証、ユーザ管理、権限管理、reCAPTCHAなど会員制のサイトを簡単に実現可能。その導入方法、カスタマイズ方法を解説。

: CakePHP 2.3でファイルのアップロード処理を作る

CakePHPでプラグインを使わないファイルアップロード処理を解説します。簡単です。DBにファイルを格納する方法も。

: CakePHP 2.3で PDFを作成する方法を調査「mpdf」「TCPDF」「FPDF」

CakePHPで PDFを編集、出力するには「mpdf」「TCPDF」「FPDF」といったプラグインがあり、使い勝手を比較検討しました。TCPDFが一番良さそうでした。

: CakePHP3でモデルなしフォームからCSVをアップロードしレコードを更新する方法解説

CakePHP3でCSVファイルをアップロードしレコードを追加、更新する処理の作成方法の解説。モデルとは直接関連しないフォームからCSVファイルをアップロードするため汎用的に使用可能。

: CakePHP3、CakePHP4のキャッシュをクリアする方法「bin/cake cache clear_all」を使う

CakePHP3、CakePHP4では処理を高速化する手法の一つとしてキャッシュを利用している。しかし、その情報は元の情報を更新しても反映されない場合がある。そんなときはキャッシュを削除する必要がある。

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

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

: CakePHP3でページごとに読み込むJavaScript、CSSを変える処理の解説

CakePHP3でJavaScriptやCSSを編集する基本形から、それらやテンプレート（エレメント）を特定のテンプレートを読み込んだときのみ編集、実行するための方法、ブロック化について解説。

: Windows環境の XAMPPを利用して CakePHPの開発する際の注意点

WindowsベースにXAMPPで環境を構築しCakePHP4を利用したWebシステムを構築する際は、大文字と小文字の違いを意識する必要がある。LinuxベースのWebサーバに移動させたときに不具合で動作しないこともある。