れぶろぐ

2008-03-04 (火)

■ ファイルを include する際にフィルタをかける方法

ストリームラッパを使って簡易テンプレートエンジンを作る方法が紹介されていました。

方法としては興味深いのですが、ちょっと大げさな感じがするので、同様のことをもっと簡単な方法でやってみました。先日のテンプレートエンジンと同じように、

<?=...?>  →  <?php echo htmlspecialchars(..., ENT_QUOTES) ?>

という変換をさせることにします。

include の代わりに eval を使う

他の方法と比べて簡単で高速です。こんなコードになります。

<?php

class MyView
{
    public function render($filename)
    {
        $buffer = file_get_contents($filename);
        $buffer = $this->_prefilter($buffer);
        extract(get_object_vars($this));
        eval('?>' . $buffer);
    }

    protected function _prefilter($buffer)
    {
        $pattern     = '/<\?=\s*(.*?)[;\s]*\?>/';
        $replacement = '<?php echo htmlspecialchars($1, ENT_QUOTES) ?>';
        return preg_replace($pattern, $replacement, $buffer);
    }
}

ゴチャゴチャ書きましたが、要は include の代わりに、

eval('?>' . filter(file_get_contents($filename)));

のように書けば良いです。

ストリームフィルタを使う

ストリームラッパを使う方法に似ていますが、 php://filter という PHP 入出力ストリームを使うと、ファイルを入出力する際にフィルタを施すことができるようです。

具体的には、こんなコードになります。

<?php

class short_tag_filter extends php_user_filter
{
    public function filter($in, $out, &$consumed, $closing)
    {
        while ($bucket = stream_bucket_make_writeable($in)) {
            $pattern      = '/<\?=\s*(.*?)[;\s]*\?>/';
            $replacement  = '<?php echo htmlspecialchars($1, ENT_QUOTES) ?>';
            $bucket->data = preg_replace($pattern, $replacement, $bucket->data);
            $consumed += $bucket->datalen;
            stream_bucket_append($out, $bucket);
        }
        return PSFS_PASS_ON;
    }
}

class MyView
{
    public function __construct()
    {
        stream_filter_register('convert.short_tag', 'short_tag_filter');
    }

    public function render($filename)
    {
        extract(get_object_vars($this));
        include 'php://filter/read=convert.short_tag/resource=' . $filename;
    }
}

こちらの方法は、include 以外のファイル入出力関数とも組み合わせられるはずです。参考のために、テストに使ったコードを置いておきます。