setOption()

setOption() -- テンプレートクラスのオプションを設定する

概要

require_once 'HTML/Template/Sigma.php';

mixed HTML_Template_Sigma::setOption (string $option, mixed $value)

説明

テンプレートクラスのオプションを設定します。現在は、以下のオプションが設定可能です。

preserve_data

TRUE に設定すると、 setVariable() および setGlobalVariable() で追加されたデータについて、変数の置換や未使用プレースホルダの削除を行いません。 バグ #20199 および #21951 も参照ください。 パフォーマンス上の理由により、デフォルトは FALSE です。

trim_on_save

キャッシュの保存時にテンプレートから余計な空白を取り除くかどうか。 通常はこのオプションを有効にしておくほうが安全ですが、 テンプレート内で <pre></pre> を使用している場合や HTML の字下げを保持したい場合は無効にします。 デフォルトは TRUE です。

charset

組み込みのコールバック 'h' および 'e' が使用する文字セット。 デフォルトは 'iso-8859-1' です。 リリース 1.2.0 以降で使用可能です。

パラメータ

string $option

オプション名。

mixed $value

オプションの値。

返り値

成功した場合に SIGMA_OK、失敗した場合エラーオブジェクトを返します。

例外・エラー

表 47-1PEAR_Error の値

エラーコードエラーメッセージ原因対応
SIGMA_UNKNOWN_OPTIONUnknown option '$option'$option は、Sigma で使用できませんオプション名のスペルを確認します

注意

この関数は、スタティックにコールする ことはできません。