phpDocumentor ZNF
Presentation
[ class tree: ZNF ] [ index: ZNF ] [ all elements ]
ZNF
Packages:
ZNF

Source for file Smarty.php

Documentation is available at Smarty.php

  1. <?php
  2. /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
  3. /**
  4.  * PHP version 5
  5.  *
  6.  * This source file is subject to version 2.1 of the GNU Lesser General Public
  7.  * License, that is bundled with this package in the file COPYING, available
  8.  * through the world wide web at the following URI:
  9.  * http://www.gnu.org/copyleft/lesser.html.
  10.  *
  11.  * @package    ZNF
  12.  * @subpackage Presentation
  13.  * @author     Alessandro Rossini <http://www.alessandrorossini.org>
  14.  * @author     Graziano Liberati <http://www.liberati.org>
  15.  * @copyright  2004-2007 The ZNF Development Team
  16.  * @license    LGPL License 2.1 <http://www.gnu.org/copyleft/lesser.html>
  17.  * @version    SVN $Id: Smarty.php 43 2007-06-26 23:36:35Z aronnax $
  18.  * @since      Release 0.5.0
  19.  * @link       http://www.zeronotice.org
  20.  */
  21.  
  22. require_once('Smarty/Smarty.class.php');
  23. require_once('ZNF/Presentation/Render.php');
  24.  
  25. /**
  26.  * <i>ZNF_Presentation_Smarty</i> class extends the <i>ZNF_Presentation_Render</i> class and use the <i>Smarty</i> class of the <i>Smarty</i> package for the renderization.
  27.  *
  28.  * Render data using package or theme templates.
  29.  *
  30.  * @access     public
  31.  * @package    ZNF
  32.  * @subpackage Presentation
  33.  * @author     Alessandro Rossini <http://www.alessandrorossini.org>
  34.  * @author     Graziano Liberati <http://www.liberati.org>
  35.  * @copyright  2004-2007 The ZNF Development Team
  36.  * @license    LGPL License 2.1 <http://www.gnu.org/copyleft/lesser.html>
  37.  * @version    SVN $Id: Smarty.php 43 2007-06-26 23:36:35Z aronnax $
  38.  * @since      Release 0.5.0
  39.  * @link       http://www.zeronotice.org
  40.  */
  41. class ZNF_Presentation_Smarty extends ZNF_Presentation_Render
  42. {
  43.  
  44.     const SMARTY_CACHING = false;
  45.  
  46.     const SMARTY_COMPILE_CHECK = true;
  47.  
  48.     const SMARTY_DEBUGGING = ZNF::DEBUG;
  49.  
  50.     const SMARTY_FORCE_COMPILE = false;
  51.  
  52.     /**
  53.      * The <i>Smarty</i> object
  54.      *
  55.      * @access protected
  56.      * @var string $_smarty 
  57.      */
  58.     protected $_smarty = null;
  59.  
  60.     /**
  61.      * Constructs a new <i>ZNF_Presentation_Smarty</i> object and sets the internal properties with application settings.
  62.      *
  63.      * @access public
  64.      * @param string $package Name of the package to which the smarty template
  65.      *                         refers, leave null this parameter to refer to the
  66.      *                         theme smarty templates
  67.      * @param ZNF_Action_ActionMapping $mapping 
  68.      */
  69.     public function __construct($package = null, $mapping = null)
  70.     {
  71.         parent::__construct($package, $mapping);
  72.  
  73.         $this->_smarty = new Smarty();
  74.  
  75.         $this->_smarty->template_dir = '.';
  76.         $this->_smarty->compile_dir = ZNF::CACHE_DIR;
  77.         $this->_smarty->config_dir = ZNF::CONFIG_DIR;
  78.         $this->_smarty->cache_dir = ZNF::CACHE_DIR;
  79.         $this->_smarty->caching = self::SMARTY_CACHING;
  80.         $this->_smarty->compile_check = self::SMARTY_COMPILE_CHECK;
  81.         $this->_smarty->debugging = self::SMARTY_DEBUGGING;
  82.         $this->_smarty->force_compile = self::SMARTY_FORCE_COMPILE;
  83.     }
  84.  
  85.     /**
  86.      * Executes and returns the smarty template results.
  87.      *
  88.      * Gets the path of the smarty template, calls
  89.      * <i>ZNF_Presentation_Smarty->_assignConstants()</i> and calls the
  90.      * <i>fetch()</i> method of <i>Smarty</i>.
  91.      *
  92.      * @access public
  93.      * @param string $template File name of the smarty template
  94.      * @param mixed $data Additional data to process
  95.      * @return string 
  96.      */
  97.     public function fetch($template, $data = null)
  98.     {
  99.         $template = $this->_getTemplatePath($template, $data);
  100.  
  101.         $this->_assignConstants();
  102.  
  103.         return $this->_smarty->fetch($template, null, null, false);
  104.     }
  105.  
  106.     /**
  107.      * Executes and displays the smarty template results.
  108.      *
  109.      * Gets the path of the smarty template, calls
  110.      * <i>ZNF_Presentation_Smarty->_assignConstants()</i> and calls the
  111.      * <i>display()</i> method of <i>Smarty</i>.
  112.      *
  113.      * @access public
  114.      * @param string $template File name of the smarty template
  115.      * @param mixed $data Additional data to process
  116.      */
  117.     public function display($template, $data = null)
  118.     {
  119.         $template = $this->_getTemplatePath($template, $data);
  120.  
  121.         $this->_assignConstants();
  122.  
  123.         $this->_smarty->fetch($template, null, null, true);
  124.     }
  125.  
  126.     /**
  127.      * Assigns values to smarty template variables.
  128.      *
  129.      * @param string $param The smarty template parameter name
  130.      * @param mixed $value The value to assign
  131.      */
  132.     public function assign($param, $value)
  133.     {
  134.         $this->_smarty->assign($param, $value);
  135.     }
  136.  
  137.     /**
  138.      * Assign to a smarty template the ZNF constants.
  139.      *
  140.      * @access protected
  141.      */
  142.     protected function _assignConstants()
  143.     {
  144.         $constants = $this->_getConstants();
  145.         $this->_smarty->assign('znf', $constants);
  146.     }
  147.  
  148.     /**
  149.      * Destroys the <i>ZNF_Presentation_Smarty</i> object.</>
  150.      *
  151.      * @access public
  152.      */
  153.     public function __destruct()
  154.     {
  155.     }
  156.  
  157. }
  158.  
  159. /**
  160.  * <i>ZNF_Presentation_SmartyException</i> is the exception type for the <i>ZNF_Presentation_Smarty</i> class.
  161.  *
  162.  * <i>ZNF_Presentation_SmartyException</i> extends the <i>Exception</i> class of PHP5.
  163.  *
  164.  * @access     public
  165.  * @package    ZNF
  166.  * @subpackage Presentation
  167.  * @author     Alessandro Rossini <http://www.alessandrorossini.org>
  168.  * @author     Graziano Liberati <http://www.liberati.org>
  169.  * @copyright  2004-2007 The ZNF Development Team
  170.  * @license    LGPL License 2.1 <http://www.gnu.org/copyleft/lesser.html>
  171.  * @version    SVN $Id: Smarty.php 43 2007-06-26 23:36:35Z aronnax $
  172.  * @since      Release 0.5.0
  173.  * @link       http://www.zeronotice.org
  174.  */
  175. class ZNF_Presentation_SmartyException extends Exception
  176. {
  177. }
  178.  
  179. ?>
Documentation generated on Wed, 14 Nov 2007 23:47:41 +0100 by phpDocumentor 1.4.0