cakephpでの例外処理(try catch)の書き方を教えてください。

Question

皆さんお疲れ様です。
先日から何度もcakephp関連の質問に対して丁寧にお答えしていただきありがとうございます。
今回はすごく具体的なことをお聞きします。
質問が長くなり、見えにくいかとは思いますがご容赦ください。
私のcakephpはversion2.6.4です。

今現在、cakephpにtry catch文を用いて例外処理をしようとしています。
しかし、正直まだ例外処理をどこに書いたらよいのかもあまり理解できておりません。
バリデーションは書いていますが、これでよいのかさえ正直わかりません。
目星として、データを扱うcontroller内に書けばよいのかなとあたりをつけています。

以下コードです。

public function index() {

      //Reportコレクションに対するバリデーション--------------------------------------
      $this->Report->set($this->request->data);
      if ($this->Report->validates()) {
          //正しい場合のロジック
      } else {
          //正しくない場合のロジック
          $errors = $this->Report->validationErrors;
      }

      //Requestコレクションに対するバリデーション-------------------------------------
      $this->Request->set($this->request->data);
      if ($this->Request->validates()) {
          //正しい場合のロジック
      } else {
          //正しくない場合のロジック
          $errors = $this->Request->validationErrors;
      }

     //queryのidを元にreportのオブジェクトを取得-------------------------------------
     $reportId = $this->request->query['id'];

     $report = $this->Report->find('all', array('conditions' => array("id" => $reportId)));//そのreportsの中にあるさっきのidがあるドキュメントの情報を取得
     $report_obj = $report[0]["Report"];

     //ReportsCollectionから変数をセット-------------------------------------------
     $userid = $report_obj["userObjectId"];
     $requestId = $report_obj["requestId"];
     $reason = $report_obj["reason"];
     $message = htmlspecialchars($report_obj["message"]);
     $comment = $report_obj["comment"];
     $reportstatus = $report_obj["status"];
     $modified = $report_obj["modified"]->toDateTime()->format('Y-m-d H:i:s');
     $created = $report_obj["created"]->toDateTime()->format('Y-m-d H:i:s');

     //report_objのrequestIdから該当するオブジェクトを取得----------------------------
     $request = $this->Request->find('all', array('conditions' => array("id" => $requestId)));//先ほどのrequestIdがあるrequestsの中のドキュメントを取得
     $request_obj = $request[0]["Request"];

     //RequestsCollectionから変数をセット------------------------------------------
     $imagepath = $request_obj["imagePath"];
     $requeststatus = $request_obj["status"];

     //ビューに変数を引き渡す-------------------------------------------------------
     $this->set(compact("reportId", "userid", "requestId", "reason", "message", "comment", "reportstatus", "modified", "created", "imagepath", "requeststatus"));
     $this->set('imagehost', IMAGEPATH);
  }

このpublic function indexでは主に変数を決めてviewに渡しているだけなので、バリデーションしか書いておりません。もしここでも例外処理を書く必要があればどこにどう書けばよいのか教えていただきたいです。

次はpublic function updateです

 public function update(){

      //Reportコレクションに対するバリデーション--------------------------------------
      $this->Report->set($this->request->data);
      if ($this->Report->validates()) {
          //正しい場合のロジック
      } else {
          //正しくない場合のロジック
          $errors = $this->Report->validationErrors;
      }

      //Requestコレクションに対するバリデーション-------------------------------------
      $this->Request->set($this->request->data);
      if ($this->Request->validates()) {
          //正しい場合のロジック
      } else {
          //正しくない場合のロジック
          $errors = $this->Request->validationErrors;
      }

     $this->autoRender = false;
     //処理状態の更新--------------------------------------------------------------

     if(isset($this->request->data['report_status'])){
        $reportId = $this->request->data['report_id'];
        $report = $this->Report->find('all', array('conditions' => array("id" => $reportId)));//そのreportsの中にあるさっきのidがあるドキュメントの情報を取得
        $report_obj = $report[0]["Report"];
        $report_obj["status"] = $this->request->data['report_status'];
        $report_obj["modified"] = array('modified' => date('Y-m-d H:i:s'));
        $data = $report_obj;
        $this->Report->save($data);

        $this->redirect($_SERVER['HTTP_REFERER']);
     }
     //表示状態の更新--------------------------------------------------------------

     if(isset($this->request->data['request_status'])){
         $requestId = $this->request->data['request_id'];
         $request = $this->Request->find('all', array('conditions' => array("id" => $requestId)));//そのreportsの中にあるさっきのidがあるドキュメントの情報を取得
         $request_obj = $request[0]["Request"];
         $request_obj["status"] = $this->request->data['request_status'];
         $data = $request_obj;
         $this->Request->save($data);

         $reportId = $this->request->data['report_id'];
         $report = $this->Report->find('all', array('conditions' => array("id" => $reportId)));//そのreportsの中にあるさっきのidがあるドキュメントの情報を取得
         $report_obj = $report[0]["Report"];
         $report_obj["modified"] = array('modified' => date('Y-m-d H:i:s'));
         $data = $report_obj;
         $this->Report->save($data);

         $this->redirect($_SERVER['HTTP_REFERER']);
     }
     //コメントの更新--------------------------------------------------------------

     if(isset($this->request->data['report_comment'])){
         $reportId = $this->request->data['report_id'];
         $report = $this->Report->find('all', array('conditions' => array("id" => $reportId)));//そのreportsの中にあるさっきのidがあるドキュメントの情報を取得
         $report_obj = $report[0]["Report"];
         $report_obj["comment"] = $this->request->data['report_comment'];
         $report_obj["modified"] = array('modified' => date('Y-m-d H:i:s'));
         $data = $report_obj;
         $this->Report->save($data);

         $this->redirect($_SERVER['HTTP_REFERER']);
     }
  }

こちらではDBのフィールド３つに対してpostしています。
saveがあるのでこの部分に例外処理を書かなければいけないだろうとは思うのですが、
function自体に対して例外処理をかけるのか、それとも$this->Report->save();のところだけにかけるのかを教えていただきたいです。

１つとっかかりがわかればだいたいできると思うのですがとっかかりすらない状態なのでなんとか教えていただきたいです。宜しくお願い致します。

Answer 1

$this->Request->save(); この行の結果が失敗だった場合falseが返りますので、
以下の通りで大丈夫です。

if ($this->Request->save(....) === false) {
  //エラーメッセージやその後の処理
}

try catch を使う必要はないかと思います。

例外処理とは関係ありませんが、
$this->Request->save() の第3引数にフィールドリストを指定することをお勧めします。

try catch の必要性が最初から分かっている箇所では、それを未然に防ぐコードを書くべきです。
例えばゼロでの除算が発生しうる箇所では除算前にゼロか否かの判断をして適切な分岐を行います。
と、私は考えます。

Comments

[amakusa]

回答ありがとうございます！
では、他の箇所でのtry catch文は必要ない、ということでしょうか？
DBからgetでdataを持ってきたりするときには必要なくて、postでdataを送るときのみ例外処理は必要になる、という認識でよろしいのでしょうか？
質問ばかりですみませんがお願い致します。

[rik]

phpの場合は例外を投げる(throw)することによりcatchできますので、これは事前のif文などの分岐で対応できます。勝手にthrowされることは有りません。
他のコンパイラ言語の場合は自動的にthrowされる仕様の言語が有りますのでtry catch を書けばエラーを捕獲してくれます。
と思いますがこのあたりの回答は自信がありません。
と言いますのは、
私はtry catch で処理するよりは想定されるエラーが有るなら条件分岐でエラーを回避するべきと考えており、極力try catchを使わないようにしているからです。
phpではtry catchをほぼ使ったことが有りません。
例外を未然に防ぐコードを書く事により、フローが明確になりますし、デバッグ意識が高まります。
VB.NET等のコンパイラ言語ではそれなりにtry catchを使用します。
これは書き方に個人差があると思います。
逆に皆様にphpでtry catchを使用するか否か聞いてみたいですね。