リソースプラグイン

リソースプラグインは、テンプレートソースやPHPスクリプトのコンポーネントを Smarty に提供する一般的な方法と意図されています (例: データベース, LDAP, 共有メモリ, ソケット等)。

カスタムリソースは、resource.foobarxyz.php 形式のファイル名で $plugins_dir に置くか、 実行時に registerResource() で登録します。 どちらの場合も、リソースにアクセスするにはテンプレートの前にリソース名を付けて foobarxyz:yourtemplate.tpl のように指定します。

リソースのテンプレートを Smarty のコンパイラにかけたくない場合は、 Smarty_Resource_Uncompiled を継承したカスタムリソースを作りましょう。 この場合、リソースハンドラは renderUncompiled(Smarty_Internal_Template $_template) を実装する必要があります。 $_template は現在のテンプレートへの参照で、すべての割り当てられた変数を含みます。 この変数にアクセスするには、$_template->smarty->getTemplateVars() を使います。 このリソースは、レンダリング結果を単純に出力ストリームに流すだけです。 Smarty インスタンスを適切に設定しておけば、レンダリング結果を出力キャッシュすることもできあす。 サンプルが libs/sysplugins/smarty_internal_resource_php.php にあります。

リソースのコンパイル済みテンプレートをディスクにキャッシュしたくない場合は、 Smarty_Resource_Recompiled を継承したカスタムリソースを作りましょう。 このリソースは、アクセスのたびに毎回コンパイルされるようになります。オーバーヘッドが大きくなるかもしれません。 サンプルが libs/sysplugins/smarty_internal_resource_eval.php にあります。

例 18.10. カスタムリソースの使用法


<?php

/**
 * MySQL リソース
 *
 * カスタム API によるリソースの実装例。ストレージリソースとして
 * MySQL を使い、Smarty のテンプレートや設定を格納します
 *
 * テーブル定義:
 * <pre>CREATE TABLE IF NOT EXISTS `templates` (
 *   `name` varchar(100) NOT NULL,
 *   `modified` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
 *   `source` text,
 *   PRIMARY KEY (`name`)
 * ) ENGINE=InnoDB DEFAULT CHARSET=utf8;</pre>
 *
 * デモデータ:
 * <pre>INSERT INTO `templates` (`name`, `modified`, `source`) VALUES ('test.tpl', "2010-12-25 22:00:00", '{$x="hello world"}{$x}');</pre>
 *
 * @package Resource-examples
 * @author Rodney Rehm
 */
class Smarty_Resource_Mysql extends Smarty_Resource_Custom {
    // PDO インスタンス
    protected $db;
    // 準備済みの fetch() ステートメント
    protected $fetch;
    // 準備済みの fetchTimestamp() ステートメント
    protected $mtime;

    public function __construct() {
        try {
            $this->db = new PDO("mysql:dbname=test;host=127.0.0.1", "smarty", "smarty");
        } catch (PDOException $e) {
            throw new SmartyException('Mysql Resource failed: ' . $e->getMessage());
        }
        $this->fetch = $this->db->prepare('SELECT modified, source FROM templates WHERE name = :name');
        $this->mtime = $this->db->prepare('SELECT modified FROM templates WHERE name = :name');
    }
    
    /**
     * テンプレートとその更新時刻をデータベースから取得する
     *
     * @param string $name テンプレート名
     * @param string $source テンプレートソース
     * @param integer $mtime テンプレートの更新時刻を表すタイムスタンプ
     * @return void
     */
    protected function fetch($name, &$source, &$mtime)
    {
        $this->fetch->execute(array('name' => $name));
        $row = $this->fetch->fetch();
        $this->fetch->closeCursor();
        if ($row) {
            $source = $row['source'];
            $mtime = strtotime($row['modified']);
        } else {
            $source = null;
            $mtime = null;
        }
    }
    
    /**
     * テンプレートの更新時刻をデータベースから取得する
     *
     * @note このメソッドの実装は必須ではありません。コンパイルしたテンプレートから読み込むよりも早く更新時刻が取得できそうなときだけ実装しましょう。
     * @param string $name テンプレート名
     * @return integer テンプレートの更新時刻を表すタイムスタンプ
     */
    protected function fetchTimestamp($name) {
        $this->mtime->execute(array('name' => $name));
        $mtime = $this->mtime->fetchColumn();
        $this->mtime->closeCursor();
        return strtotime($mtime);
    }
}


require_once 'libs/Smarty.class.php';
$smarty = new Smarty();
$smarty->registerResource('mysql', new Smarty_Resource_Mysql());

// PHP スクリプトのリソースを使います
$smarty->display("mysql:index.tpl");
?>

     

Smarty テンプレートはこのようになります。


{include file='mysql:extras/navigation.tpl'}

     

registerResource() および unregisterResource() も参照ください。