PEAR::raiseError()

PEAR::raiseError() -- 新規に PEAR_Error オブジェクトを生成し、 オプションでエラー処理手順を指定する

概要

require_once 'PEAR.php';

PEAR_Error PEAR::raiseError (mixed $message [, int $code [, int $mode [, int|array $options [, mixed $userinfo [, string $error_class [, boolean $skipmsg]]]]]])

説明

raiseError()

パラメータ

string $message

エラーメッセージ文字列または PEAR_Error オブジェクト。 値を指定しなかった場合のデフォルトのメッセージは、 unknown error です。

integer $code

エラーコード。エラー処理を容易にするため、 簡単なエラーに対してもエラーコードの使用を推奨します。

integer $mode

エラーモード。これは、PEAR_ERROR_RETURN, PEAR_ERROR_PRINT, PEAR_ERROR_TRIGGER, PEAR_ERROR_DIE, PEAR_ERROR_CALLBACK, PEAR_ERROR_EXCEPTION のいずれかとします。 詳細な情報とこれらの定数の意味については、 setErrorHandling() を参照してください。

mixed $options

エラーオプション。これは、$mode の値に依存します。 詳しくは、 setErrorHandling() に記述されています。

mixed $userinfo

ユーザ情報(オプション)。 特定のエラーに固有の情報を保存するために使用し、 任意のフォーマットを使用できます。

string $error_class

エラーオブジェクトとして使用するエラークラスの名前。デフォルト のエラークラスは PEAR_Error です。 PEAR_Error を拡張したカスタムクラスのような 他のクラスを使用する場合には、このパラメータを使用してください。

boolean $skipmsg

コンストラクタでエラーメッセージを受け付けないカスタムクラスを 使用する場合には、このパラメータを使用してください。 $error_class パラメータを使用しない場合には、 このパラメータを使用しないでください。

返り値

PEAR_Error オブジェクトが返されます。 ただし、 PEAR_ERROR_DIE が実行を終了するか、 PEAR_ERROR_EXCEPTION がハンドルされない場合を除きます。