myb design

Sifter reference / スクリプティング

Sifterクラスには、以下のメソッドが用意されています。
以下、Perl版では、trueを1、falseをundefに読み替えてください。


set_var

置換タグによって出力される変数の値を設定します。

書式

set_var(name, value[, convert_html])

パラメータ 省略値
name string 値を設定する変数名。
value mixed 変数に設定する値。
Perlで配列変数を設定する場合はリファレンスを使用します。
convert_html bool true
(1.1.0ではfalse)
trueを指定すると、valueに含まれるHTMLエンティティ(「<」「>」「"」「&」)を変換します。

戻り値

なし


append_var

設定済みの配列変数に値を追加します。

書式

append_var(name, value[, convert_html])

パラメータ 省略値
name string 値を追加する変数名。
value mixed 変数に追加する値。
Perlで配列変数を設定する場合はリファレンスを使用します。
convert_html bool true
(1.1.0ではfalse)
trueを指定すると、valueに含まれるHTMLエンティティ(「<」「>」「"」「&」)を変換します。

戻り値

なし


display

指定したテンプレートファイルを読み込み、解釈して結果を表示します。
または、結果を文字列で返します。

書式

display(template_file[, capture_result])

パラメータ 省略値
template_file string 読み込むテンプレートへのパス(絶対パス、相対パス)。
capture_result bool false trueを指定すると、解釈した結果を表示せず文字列で返します。

戻り値

capture_resultがfalseのとき、成功時はtrue、失敗時はfalseを返します。
capture_resultがtrueのとき、成功時は解釈した結果を文字列で返します。失敗時はfalseを返します。


set_replace_tag

置換タグの開始文字列({)と終了文字列(})を変更します。

書式

set_replace_tag(begin, end[, escape])

パラメータ 省略値
begin string 置換タグの開始文字列。
end string 置換タグの終了文字列。
escape bool true trueを指定すると、メタ文字をエスケープします。

戻り値

なし


set_control_tag

制御タグの開始文字列(<!--@)と終了文字列(-->)を変更します。

書式

set_control_tag(begin, end[, escape])

パラメータ 省略値
begin string 制御タグの開始文字列。
end string 制御タグの終了文字列。
escape bool true trueを指定すると、メタ文字をエスケープします。

戻り値

なし