PEAR_ErrorStack::getErrorMessage()

PEAR_ErrorStack::getErrorMessage() -- 標準のエラーメッセージ生成コールバック

概要

require_once 'PEAR/ErrorStack.php';

string PEAR_ErrorStack::getErrorMessage (PEAR_ErrorStack &$stack, array $err [, string|false$template = FALSE])

説明

このメソッドは、独自のエラーメッセージ生成メソッドからもコールされ、 配列のパラメータの内容をテンプレートに当てはめたエラーメッセージを 生成します。3 番目のパラメータにテンプレート文字列を指定します。

変数 %__msg% は特別に予約されています。ユーザが設定したメッセージを テンプレート中のどの場所で表示するかを示すためにのみ、この変数を利用します。 たとえば以下のように利用します。

Error message: %msg% - internal error

このテンプレートに対して以下のようなメッセージが渡された場合、

<?php
$stack->push(ERROR_CODE, 'error', array(), 'server error 500');
?>

返されるエラーメッセージは "Error message: server error 500 - internal error" となります。

パラメータ

PEAR_ErrorStack &$stack

array $err

string|false $template

事前に作成されたエラーメッセージテンプレート。

例外・エラー

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

注意

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