PEAR_ErrorStack::singleton()

PEAR_ErrorStack::singleton() -- このパッケージの唯一のエラースタックを返す

概要

require_once 'PEAR/ErrorStack.php';

PEAR_ErrorStack & PEAR_ErrorStack::singleton (string $package [, callback $msgCallback = FALSE [, callback $contextCallback = FALSE [, boolean $throwPEAR_Error = FALSE, string [$stackClass = 'PEAR_ErrorStack']]]])

後方互換性のための警告

警告

PEAR 1.3.2 では、PEAR_ErrorStack は PHP 5 の例外オブジェクトを 生成しませんし、それを返すこともありません。2 番目以降のパラメータは 削除されます。この挙動に依存しているコードはうまく動作しません。

説明

$package パッケージのスタックがすでに生成されている場合は、 すべてのパラメータが無視されることに注意しましょう。

パラメータ

string $package

このエラースタックが表しているパッケージの名称。

callback $msgCallback

エラーメッセージの生成に利用されるコールバック。

callback $contextCallback

コンテキスト情報の生成に利用されるコールバック。 デフォルトは getFileLine()

boolean $throwPEAR_Error

TRUE を指定すると、 PEAR_ErrorStack::push() がコールされた際には PEAR::raiseError() がコールされ、 PEAR_Error オブジェクトが返されます。

string $stackClass

生成するクラス。

例外・エラー

例外はスローされません。

注意

この関数は、スタティックにコール されます。