エラー処理モジュール

モジュールErrはエラー処理クラスです。フレームワークが自動で出力するエラーに加えて自由に開発者が指定するエラーメッセージをセットして表示できます。

エラーメッセージをセットするには現在のクラスからメソッドnewModule('Err')を呼び出してエラークラスのインスタンスを生成し、save(string $msg)でメッセージの文字列をセットします。

メソッド

エラークラスのメソッドは以下のとおりです。

save(string $msg)
$msgをエラーメッセージとして設定します。
load(string $default_msg = NULL)
save()されているエラーメッセージを取得します。save()されていない場合に返すメッセージをdefault_msgで指定できます。
free()
save()されているエラーメッセージを解放します。

使い方

通常、エラーメッセージをセットしたいところで

$this->newModule('err')->save('エラーメッセージ!');

を実行すればいいはずです。このメソッドsave(string $msg)で指定したエラーメッセージはビューから$_err_msgで前後を囲むHTMLタグ(<div>や<span>など)付きで表示できます。プログラムで

<?
class ctrlXxx extends CZCtrl {
	public function actionYyy() {
			:
		if (!$recs = $this->newModel('stock')->getRecords(...)) {
			$this->newModule('err')->save('在庫が登録されていません。');
		}
			:
	}
}
?>

自作エラーメッセージを表示させる場合はビューで

<? if($_err_msg): ?><?= $_err_msg ?><? endif; ?>

を入れます。なおエラーメッセージは一度表示されると消去されます。したがってリロードした時にも消えますので注意してください。

メッセージを囲むHTMLタグは設定ファイル{(app_root), _common}/configs/Err.phpmsg_head_strmsg_tail_strで設定できます。

前後のページ

ページトップへ