PHP/拡張モジュール/Simplate/改造

Simplate を自動的に HTML エスケープさせる †

目次 †

• 概要
• インストール
• 設定
• 使い方
• ダウンロード
• 履歴

概要 †

Simplate の中の人のブログで simplateでデフォルトでhtmlspecialcharsを使ってみる という記事が公開されていますが、 それを参考に、エスケープを制御するためのパッチを作成してみました。

• Flexy のように自動的に HTML エスケープさせることができます *1
• エスケープに用いる関数をユーザーが設定できます
• 部分的にエスケープをオフにするための記法を追加します

インストール †

パッチファイル (simplate_escape.tar.gz) をダウンロードし、 Simplate のビルド時にパッチを適用して下さい。

$ ……
$ cd simplate-0.4.1
$ tar xvfz simplate_escape.tar.gz
$ patch < simplate-0.3.8_escape.diff
$ phpize
$ ……

Simplate のインストール手順そのものについては、 こちら のページを見て下さい。

設定 †

このパッチを適用すると、simplate クラスに次の２つのプロパティが追加されます。

• escape_function
• escape_options

パッチをあてただけの状態では、今までと同じ動作をします。 自動的に HTML エスケープの処理が行われるようにするためには、

$simplate = new simplate();
$simplate->escape_function = 'htmlspecialchars';
$simplate->escape_options  = 'ENT_QUOTES';

のように PHP のスクリプト内で設定して下さい。 この設定例の場合、テンプレート中の変数は、

のように展開されるようになります。

使い方 †

テンプレート中のある部分だけエスケープをオフにしたい場合は、

<{-$var}>

のように先頭にマイナス記号をつけて下さい。 また、Simplate は関数呼び出しによって、 Smarty でいうところの修飾子と同じことができるので、

<{-rawurlencode($url)}>

のように書けば、その他のエスケープにも対応できます。

エスケープに関して、注意事項をいくつか書いておきます。

• マイナス記号は、ドル記号の前ではなく left_delimiter の直後に書いて下さい
• エスケープは１つ１つの変数に対してではなく、デリミタで囲まれた範囲の出力全体に対して行われます *2

ダウンロード †

• simplate_escape.tar.gz

履歴 †

最新の20件

Skin by YEAR OF THE CAT