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 コメントをキャンセル

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

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

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

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

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

: CakePHP4で公開側と管理側のデザインテンプレートを分ける方法・setLayout()

CakePHP4でデフォルトのレイアウトファイル「default.php」は管理側に使用し、これとは別のデザインを公開側のページに設定したい、を実装する方法を解説。

: CakePHP4の規約外のカラムをキーにアソシエーション（テーブル連結）する方法

CakePHPで規定外のカラム名のキーを指定してアソシエーション（テーブル連結）をする方法を解説。アソシエーション名によってはミスが発生しやすい点もあるので注意も必要。

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

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

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

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

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

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

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

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

: CakePHP3ログファイルへの出力・$this->log()、独自ログへの出力方法の解説

コントロール、モデルの変数の中身を見るときはログに出力する方法が有効です。$this->log()を利用すると変数だけじゃなく、連想配列、オブジェクトも簡単にログ出力ができます。

: CakePHP3の検索プラグイン「friendsofcake/search」の様々な検索の仕方の実装方法

CakePHP3で検索をするプラグイン「friendsofcake/search」の検索条件のカスタマイズ方法の解説。検索項目を増やしたり、以上、以下での検索や、チェックボックスによる検索の方法などを解説。