Zend FrameworkとSmartyを連携させる（１）

今回はZend Frameworkのフレームワーク機能の中に、Smartyのテンプレートエンジンを組み込みます。

Zend FrameworkではMVCモデルを採用していますが、Viewの部分はあくまで見栄えを切り離しただけで、Smartyのようなテンプレート機能は備えていません。そこで、Zend Frameworkの公式マニュアルでも紹介されえているSmartyラッパーを実装してみます。
Zend Framework: Documentation: ビュースクリプト – Zend Framework Manual

まずはそれぞれのバージョンは以下のとおりです。

Apache	2.2.12
PHP	5.3.0
Zend Framework	1.11.1
Smarty	2.6.26

前提としては、前回の「Zend FrameworkでHello World!」までは確認済みという状態から作業を始めます。ここでディレクトリ構造について確認しておきます。

Zend Frameworkコントローラ	/application/controllers
Zend Frameworkビューワー	/application/views/scripts
Smartyキャッシュ	/application/smarty/cache
Smarty設定	/application/smarty/configs
Smartyテンプレート	/application/smarty/templates
Smartyテンプレートキャッシュ	/application/smarty/templates_c
Smartyインストール先	/library/smarty
Apacheドキュメントルート	/web

手始めに、マニュアルで紹介されているラッパーをそのままコピーして利用します。クラスは「/application/smarty/Zend_View_Smarty.class.php」に配置します。

class Zend_View_Smarty implements Zend_View_Interface
{
    /**
     * Smarty object
     * @var Smarty
     */
    protected $_smarty;
 
    /**
     * コンストラクタ
     *
     * @param string $tmplPath
     * @param array $extraParams
     * @return void
     */
    public function __construct($tmplPath = null, $extraParams = array())
    {
        $this->_smarty = new Smarty;
 
        if (null !== $tmplPath) {
            $this->setScriptPath($tmplPath);
        }
 
        foreach ($extraParams as $key => $value) {
            $this->_smarty->$key = $value;
        }
    }
 
    /**
     * テンプレートエンジンオブジェクトを返します
     *
     * @return Smarty
     */
    public function getEngine()
    {
        return $this->_smarty;
    }
 
    /**
     * テンプレートへのパスを設定します
     *
     * @param string $path パスとして設定するディレクトリ
     * @return void
     */
    public function setScriptPath($path)
    {
        if (is_readable($path)) {
            $this->_smarty->template_dir = $path;
            return;
        }
 
        throw new Exception('無効なパスが指定されました');
    }
 
    /**
     * 現在のテンプレートディレクトリを取得します
     *
     * @return string
     */
    public function getScriptPaths()
    {
        return array($this->_smarty->template_dir);
    }
 
    /**
     * setScriptPath へのエイリアス
     *
     * @param string $path
     * @param string $prefix Unused
     * @return void
     */
    public function setBasePath($path, $prefix = 'Zend_View')
    {
        return $this->setScriptPath($path);
    }
 
    /**
     * setScriptPath へのエイリアス
     *
     * @param string $path
     * @param string $prefix Unused
     * @return void
     */
    public function addBasePath($path, $prefix = 'Zend_View')
    {
        return $this->setScriptPath($path);
    }
 
    /**
     * 変数をテンプレートに代入します
     *
     * @param string $key 変数名
     * @param mixed $val 変数の値
     * @return void
     */
    public function __set($key, $val)
    {
        $this->_smarty->assign($key, $val);
    }
 
    /**
     * empty() や isset() のテストが動作するようにします
     *
     * @param string $key
     * @return boolean
     */
    public function __isset($key)
    {
        return (null !== $this->_smarty->get_template_vars($key));
    }
 
    /**
     * オブジェクトのプロパティに対して unset() が動作するようにします
     *
     * @param string $key
     * @return void
     */
    public function __unset($key)
    {
        $this->_smarty->clear_assign($key);
    }
 
    /**
     * 変数をテンプレートに代入します
     *
     * 指定したキーを指定した値に設定します。あるいは、
     * キー => 値 形式の配列で一括設定します
     *
     * @see __set()
     * @param string|array $spec 使用する代入方式 (キー、あるいは キー => 値 の配列)
     * @param mixed $value (オプション) 名前を指定して代入する場合は、ここで値を指定します
     * @return void
     */
    public function assign($spec, $value = null)
    {
        if (is_array($spec)) {
            $this->_smarty->assign($spec);
            return;
        }
 
        $this->_smarty->assign($spec, $value);
    }
 
    /**
     * 代入済みのすべての変数を削除します
     *
     * Zend_View に {@link assign()} やプロパティ
     * ({@link __get()}/{@link __set()}) で代入された変数をすべて削除します
     *
     * @return void
     */
    public function clearVars()
    {
        $this->_smarty->clear_all_assign();
    }
 
    /**
     * テンプレートを処理し、結果を出力します
     *
     * @param string $name 処理するテンプレート
     * @return string 出力結果
     */
    public function render($name)
    {
        return $this->_smarty->fetch($name);
    }
}

次に、フロントコントローラでラッパーインスタンスを生成して、ヘルパーブローカーへ渡します。

error_reporting(E_ALL|E_STRICT);
ini_set('display_errors', 1);
date_default_timezone_set('Asia/Tokyo');

define('APP_DIR', dirname(dirname(__FILE__)) . '/application/');
define('APP_SMARTY_DIR', APP_DIR . '/smarty/');
define('SMARTY_DIR', '../library/smarty/');
define('SMARTY_WRAPPER_DIR', '../application/smarty/');

// directory setup and class loading
set_include_path('.' . PATH_SEPARATOR . '../library/smarty/'
    . PATH_SEPARATOR . SMARTY_DIR
    . PATH_SEPARATOR . get_include_path());
require_once 'Zend/Loader/Autoloader.php';
$autoloader = Zend_Loader_Autoloader::getInstance();
$autoloader->setFallbackAutoloader(true);

// setup controller
$frontController = Zend_Controller_Front::getInstance();
$frontController->throwExceptions(true);
$frontController->setControllerDirectory(APP_DIR . 'controllers');

// smarty setup
require_once( SMARTY_DIR .'Smarty.class.php' );
require_once(SMARTY_WRAPPER_DIR . 'Zend_View_Smarty.class.php');
$view = new Zend_View_Smarty(
    APP_SMARTY_DIR . 'templates',
    array(
        'compile_dir' => APP_SMARTY_DIR . 'templates_c',
        'config_dir'  => APP_SMARTY_DIR . 'configs',
        'cache_dir'   => APP_SMARTY_DIR . 'cache'
    )
);

$viewRenderer = Zend_Controller_Action_HelperBroker::getStaticHelper('ViewRenderer');
$viewRenderer->setView($view)
             ->setViewBasePathSpec($view->getEngine()->template_dir)
             ->setViewScriptPathSpec(':controller/:action.:suffix')
             ->setViewScriptPathNoControllerSpec(':action.:suffix')
             ->setViewSuffix('html');

// run!
$frontController->dispatch();

5～8行目で、それぞれのパスを設定します。
APP_DIRにはZend Frameworkのコントローラなどを配置しているディレクトリ、APP_SMARTY_DIRにはSmartyの作業ディレクトリ、SMARTY_DIRにはSmaryがインストールされているディレクトリ、SMARTY_WRAPPER_DIRには先ほど作成したラッパーを置いてあるディレクトリパスを設定します。

10～21行目でZend Frameworkの必要なクラスを読み込み、コントローラーを設定します。

23～33行目でSmartyを設定します。各ディレクトリを設定するのは、Smaryの仕様で使用する場合と一緒です。

35～40行目でヘルパーブローカーへ渡します。テンプレートの拡張子は、「tpl」や「phtml」にする例をよく見かけますが、私はエディタなどの関連を保つために「html」にしてあります。

一見めんどくさいですが、どのプロジェクトにも流用できるので、一度構築したらベースライブラリとして保存しておくと作業を短縮することができますね。

さて、これで動くはずです。動作確認は次回。