在Zend Framework 应用中使用Smarty做模版引擎

来源:互联网 发布:2017年7月经济数据 编辑:程序博客网 时间:2024/06/05 21:13
Zend Framework 是 PHP 官方出的开发框架,随着 PHP5 的推广,越来越多的人开始学习、使用 Zend Framework。 Smarty 是一个非常强大的模版引擎,由于其完善的语法、内置的缓存功能,已经被众多开发人员应用在自己的开发项目中。

正因为二者的强大,因此有越来越多的人开始考虑将 Smarty 集成到 Zend Framework ,以便充分的发挥各自的优点。本文翻译自 Zend Developer Zone 。翻译为意译,由于水平有限,纰漏在所难免,欢迎指出翻译中出现的问题。本文为 CodeBit.cn ( http://www.codebit.cn ) 组织翻译,转载请注明出处。

原文作者首先指明了整合的目的:(1)保留 Zend_View 提供的 API;(2)利用 Smarty 提供的缓存功能。

目录结构:

文件名是按照作者的公司(Travello)命名:
Code:

   /Zend
     /View
   /Travello
     /View
       Smarty.php


定义类和构造函数:
首先是定义类和构造函数, Travello_View_Smarty 是继承自 Zend_View_Abstract,在构造函数中首先调用了父类的构造函数,然后将初始化好的 Smarty 对象存储在 private 属性中。

注意:这里使用了 configuration 对象存取 Smarty 的配置信息。

PHP:
  1. <?php
  2. class Travello_View_Smarty extends Zend_View_Abstract
  3. {
  4. private $_smarty = false;
  5. public function __construct($data = array())
  6. {
  7. parent::__construct($data);
  8. $config = Zend::registry('config');
  9. $this->_smarty = new Smarty();
  10. $this->_smarty->caching = $config->getSetting('smarty', 'caching');
  11. $this->_smarty->cache_lifetime = $config->getSetting('smarty', 'cache_lifetime');
  12. $this->_smarty->template_dir = $config->getSetting('smarty', 'template_dir');
  13. $this->_smarty->compile_dir = $config->getSetting('smarty', 'compile_dir');
  14. $this->_smarty->config_dir = $config->getSetting('smarty', 'config_dir');
  15. $this->_smarty->cache_dir = $config->getSetting('smarty', 'cache_dir');
  16. }


实现 _run() 方法:
_run() 是唯一的需要在 Zend_View_Abstract 子类中实现的方法,他会自动在 render() 方法中被调用,这里使用了 Smarty 的 display() 方法来输出模版。

PHP:
  1. <?php
  2. protected function _run($template)
  3. {
  4. $this->_smarty->display($template);
  5. }


重写 assign() 方法:
下面是要重写 Zend_View_Abstract 下面的 assign() 方法,我们直接将参数值赋到 Smarty 对象,而不是默认的 Zend_View_Abstract 的 $this->_vars 数组。

PHP:
  1. <?php
  2. public function assign($var)
  3. {
  4. if (is_string($var))
  5. {
  6. $value = @func_get_arg(1);
  7. $this->_smarty->assign($var, $value);
  8. }
  9. elseif (is_array($var))
  10. {
  11. foreach ($var as $key => $value)
  12. {
  13. $this->_smarty->assign($key, $value);
  14. }
  15. }
  16. else
  17. {
  18. throw new Zend_View_Exception('assign() expects a string or array, got '.gettype($var));
  19. }
  20. }


重写 escape() 方法:
下面是要重写 Zend_View_Abstract 下面的 escape() 方法,使用的是 Zend_View_Abstract 内置的 escape() 方法,但是能够根据传入的字符串或者数组作出相应处理。

PHP:
  1. <?php
  2. public function escape($var)
  3. {
  4. if (is_string($var))
  5. {
  6. return parent::escape($var);
  7. }
  8. elseif (is_array($var))
  9. {
  10. foreach ($var as $key => $val)
  11. {
  12. $var[$key] = $this->escape($val);
  13. }
  14. return $var;
  15. }
  16. else
  17. {
  18. return $var;
  19. }
  20. }


打印输出:
output() 是对 Zend_View_Abstract 中 render() 方法的封装,增加了一些 header 设置:

PHP:
  1. <?php
  2. public function output($name)
  3. {
  4. header("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
  5. header("Cache-Control: no-cache");
  6. header("Pragma: no-cache");
  7. header("Cache-Control: post-check=0, pre-check=0", FALSE);
  8. print parent::render($name);
  9. }


使用 Smarty 的缓存:
最后的2个方法是为了在 View 类中整合 Smarty 的缓存机制,第一个方法是检查是否已经缓存,第二个是设置是否打开缓存功能。

PHP:
  1. <?php
  2. public function isCached($template)
  3. {
  4. if ($this->_smarty->is_cached($template))
  5. {
  6. return true;
  7. }
  8. return false;
  9. }
  10. public function setCaching($caching)
  11. {
  12. $this->_smarty->caching = $caching;
  13. }
  14. } // end Travello_View_Smarty
  15. ?>


上面是完整的 Travello_View_Smarty 代码。

使用说明:
使用非常简单,在你的导入文件(通常是 index.php ,译注)中,可以用下面的方法初始化, $viewConfig 是设置 Zend_View 的路径,一旦创建好对象后,就将他存在对象中,方便后面调用。

PHP:
  1. <?php
  2. $viewConfig = array();
  3. $viewConfig['scriptPath'] = $config->getSetting('framework', 'view_dir');
  4. $view = new Travello_View_Smarty($viewConfig);
  5. Zend::register('view', $view);
  6. ?>


在你的 controller 和 action 方法中可以这样使用:

PHP:
  1. <?php
  2. public function indexAction()
  3. {
  4. $temp_file = 'homepage.htm';
  5. $view = Zend::registry('view');
  6. if (false === $view->isCached($temp_file))
  7. {
  8. $vars = array();
  9. $vars['title' ] = 'Page <title>';
  10. $vars['text' ] = 'A text is a text & a text is a text.';
  11. $vars['numbers'][0] = 12.9;
  12. $vars['numbers'][1] = 29;
  13. $vars['numbers'][2] = 78;
  14. $vars = $view->escape($vars);
  15. $view->assign($vars);
  16. }
  17. $view->output($temp_file);
  18. }
  19. ?>
原创粉丝点击