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 2.3で PDFを作成する方法を調査「mpdf」「TCPDF」「FPDF」

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

: CakePHP 2.3でファイルをアップロード・その2　ファイル名を乱数で設定

CakePHPのアップロードするファイル名を乱数で変更しセキュリティを高める方法を解説。

: CakePHP3のアソシエーション機能を使い関連レコードをまとめて削除

CakePHP3でレコードを削除する際に関連するレコードをまとめて削除する機能の解説。フレームワークのメリットを存分に発揮し、コマンドを1行追加するだけで実装可能。

: CakePHP4の数値項目は「like %10%」の部分一致検索（find select）はできない

CakePHP4でテーブルの数値項目に対してlike句を使用した部分一致検索を実行するとエラーが発生する。クリエービルダーの不具合だと思われ対処方法が分からない。

: CakePHP 2.3　ID以外のカラムでアソシエーション（連携）をさせる場合の詳細ページの注意点

ID以外のカラムでアソシエーション（連携）させて詳細ページを表示させる際の考え方と注意点をサンプルソースを用いて解説しています。

: CakePHP 2.3　Search Pluginで検索処理　その５入力項目に複数項目入力した場合の AND検索、OR検索

CakePHPの検索プラグイン Search Pluginの検索処理の中で複数項目を入力した場合の AND検索、OR検索についての解説です。

: CakePHP 2.3で確認画面付きのお問い合わせフォームの作り方

CakePHPで確認画面付きのお問い合わせフォーム、メールフォームの作り方をサンプルを提示しながら解説。

: CakePHP3でデータを保存する save()で発生するエラーを確認する方法を解説

CakePHP3でデータ保存処理のログを取得する方法。save()では true、falseの戻り値しか取得できないが、saveOrFail()と try…catch文を使いエラーログ、エンティティを取得し、不具合の解析を行う。

: CakePHP 2.3 Model、Controllerの見たい変数の中身をログ出力

CakePHPの Modelや Controllerの変数の中身をログとして出力して見る方法を提供します。

: MySQL、CakePHP 2.3で「tinyint(1)」の Boolean型の動作を再確認

MySQL＋CakePHPの環境で「tinyint(1)」を利用する際の動作を検証。「tinyint(1)」の Boolean型について CakePHPでは自動処理が実施されていることを確認しました。