Smartyの修飾子を作成する
Smartyには、テンプレート上で関数を実行して値の加工を行う機能があります。この機能を修飾子といいます。使用する際にはテンプレート内に以下のようにSmarty変数の後ろに「|(パイプ)」をつけて記述します。
{$value|修飾子}
代表的な修飾子には次のようなものがあります。
| 修飾子名 | 概要 |
| upper | 値に含まれる英字をすべて大文字に置換する |
| lower | 値に含まれる英字をすべて小文字に置換する |
| nl2br | 文字列の改行を「<br />」に置換する |
| popoup | javascriptのポップアップを出力する |
| escape | 値に含まれるHTMLタグをエスケープする |
| date_format | 日時、時刻の出力パターンを指定する |
修飾子で呼び出される関数のソースはlibs/pluginディレクトリに配置されており、ここに関数を作成することでSmartyのテンプレートで使用できる修飾子を任意で作成できます。サンプルではサイトの携帯対応の1つとしてPHPのmb_convert_kana関数を使用して全角英数字カナを半角英数字カナに変換する修飾子を作成します。
mb_convert_kanaのオプションには次のようなものがあります。
| オプション | 意味 |
| r | 「全角」英字を「半角」に変換 |
| R | 「半角」英字を「全角」に変換 |
| n | 「全角」数字を「半角」に変換 |
| N | 「半角」数字を「全角」に変換 |
| a | 「全角」英数字を「半角」に変換 |
| A | 「半角」英数字を「全角」に変換 |
| s | 「全角」スペースを「半角」に変換 |
| S | 「半角」スペースを「全角」に変換 |
| k | 「全角片仮名」を「半角片仮名」に変換 |
| K | 「半角片仮名」を「全角片仮名」に変換 |
| h | 「全角ひら仮名」を「半角片仮名」に変換 |
| H | 「半角片仮名」を「全角ひら仮名」に変換 |
| c | 「全角かた仮名」を「全角ひら仮名」に変換 |
| C | 「全角ひら仮名」を「全角かた仮名」に変換 |
今回は全角英数字カナを半角英数字カナに変換するので使用するオプションは「r」「n」「a」「k」になります。
以上のことを踏まえて作成する修飾子のソースは次のようになります。
function smarty_modifier_convert_z2h($string)
{
if (function_exists("mb_convert_kana")) {
$string = mb_convert_kana($string,"rnask", "UTF-8");
}
return $string;
}
上記のコード内で「$string」で定義された変数が「|」の左側の値になります。作成した修飾子を利用するテンプレートは以下のようになります。
<tr><td>書籍名</td><td>発行日</td></tr>
{foreach from=$books key=k item=i}
<tr><td>{$i.title|convert_z2h} </td><td>{$i.published}</td></tr>
{/foreach}
作成した修飾子の確認のため、以下のSQLを実行して全角英数字カナのデータを作成しておきます。
INSERT INTO `test`.`books` (`id` ,`title` ,`published_date`) VALUES (NULL , 'abcde12345アイウエオ', '');

books.php実行結果と比較、追加したデータを参照すると、全角英数字カナが半角英数字カナに変換されていることが分かります。
