エラー処理

Ethna > ドキュメント > 開発マニュアル > エラー処理

エラー処理

エラー処理ポリシー

エラーコードの定義

エラーレベルに応じて共通画面を表示させる

書いた人: いちい

概要

Ethnaはフレームワークとしてエラーハンドリングの機能を用意しています。

Ethnaで登場するエラーを、大きく次の2つに分類することにします。アプリケーションの開発スタイルまで考えると明確な分類は難しいですが、発生したエラーの扱いが大きく異なっていることに注意してください。

開発段階のエラー
- 文法エラーやtrigger_error()で発生するphpのエラー*1
- Ethna_Error.phpで定義されたグローバル関数 ethna_error_handler() が受け取る

運用段階のエラー
- Ethna::raiseError()で発生するエラー
- アプリケーションのコントローラクラス App_Controller の handleError() が受け取る

両者の大きな違いは、エラーが発生したときの処理の実装がアプリケーション側にあるかどうかです。(デフォルトでは App_Controller の handlerError() は実装されていないので、継承元の Ethna_Controller の handleError() が実行されます。)

これを開発段階と運用段階と分類したのは、前者のエラーは処理を制御しにくいために運用段階で発生させるべきでないからです。もちろんset_error_handler()をアプリケーションで設定することも可能ですが、おすすめはしません。

ethna_error_handler()の処理内容

error_reporting()の値を考慮しつつ、発生したエラーをアプリケーションのログに出力します。ログについてはログのページを参照してください。

また、アプリケーションの設定ファイル etc/app-ini.php 内で 'debug' => true と指定されてあり、さらにログに 'echo' が含まれない場合は、エラー内容を printf で出力します。

この挙動は、ethna_error_handler()が呼び出されるエラーを開発段階の時点で捕捉するためです。たとえば宣言していない変数にアクセスするなどのエラーは、開発段階で修正するようにしてください。

Ethna::raiseError()

Ethna クラスは PEAR クラスを継承しています。 Ethna::raiseError(), Ethna::raiseWarning(), Ethna::raiseNotice() は適切なエラーレベルとエラークラスとして Ethna_Error を指定して PEAR::raiseError() を呼び出します。

PEAR::raiseError() 内で Ethna_Error クラスのインスタンスが作られ、そのコンストラクタでアプリケーションのコントローラの handleError() が実行されます。デフォルトではログにエラーが出力されます。

複雑な仕組みですが、raiseError()を呼び出したときのみ handleError() が実行され、その後の文脈でもエラーを Ethna_Error のオブジェクトとして取り回すことができます。例えば、呼び出した関数が Ethna_Error を返してきた場合、そのエラーをそのまま呼出元に丸投げすれば、エラーが二重に出力されることなくエラーの発生を伝達できます。

Ethna_ActionErrorクラス

運用段階のエラーについては、意図しないエラーの発生(ex, データベースへの接続に失敗したなど)を示すエラーと、アプリケーションの正常動作の中で表現したいエラー(ex, ユーザの入力文字数がオーバーしたなど)との2通りがあるとおもいます。

Ethnaでは、アクション実行中に発生したエラーをビューの遷移先で参照するために、ActionErrorというエラーのコンテナが用意されています。

現在のところフォーム(ActionForm)に強く依存した実装になっているので、今後より便利なものとしてゆく予定です。

具体例

アクションクラス:

function perform()
{
    $obj =& $this->backend->getObject('someobj');
    if (Ethna::isError($obj)) { // Ethna::isError() でエラーかどうか判定
        $this->ae->add($obj)    // ActionErrorに発生したエラーを登録
    }
}

ビュークラス:

function preforward()
{
    if ($this->ae->count() > 0) { // 先ほど登録したエラーをここで参照できる
        ...
    }
}

*1 より正確にはzend_error()でエラーハンドラに渡るもの

エラー処理