includes/templates.php

   1 <?php
   2 /**
   3 * @category News
   4 * @package News_Templates
   5 * @copyright Copyright (c) 2008, Bellière Ludovic
   6 * @license http://opensource.org/licenses/mit-license.php MIT license
   7 */
   8
   9 class templates_exception extends Exception {}
  10
  11 /**
  12 * @author Bellière Ludovic
  13 * @category News
  14 * @package News_Templates
  15 * @copyright Copyright (c) 2008, Bellière Ludovic
  16 * @license http://opensource.org/licenses/mit-license.php MIT license
  17 */
  18 class templates {
  19     /**
  20      * File list
  21      *
  22      * @var array
  23      */
  24     protected $_files = array();
  25
  26     /**
  27      * Path to the templates files
  28      *
  29      * @var string
  30      */
  31     protected $_templatePath;
  32
  33     private $_escape = array('htmlentities');
  34
  35     public function __construct($template_path='./templates/') {
  36         $this->_templatePath = $template_path;
  37     }
  38
  39     /**
  40      * Return the current tempalte path
  41      */
  42     public function getTemplatePath() {
  43         return $this->_templatePath;
  44     }
  45
  46     /**
  47      * Add a template file
  48      */
  49     public function addFile($tag,$name) {
  50         $this->_files[$tag] = $name;
  51     }
  52
  53     /**
  54      * Process the templates files by $tag
  55      * $tag can be an array for multi-templates page.
  56      *
  57      * @param array|string $tag
  58      */
  59     public function render($tag) {
  60         try {
  61             if (!is_array($tag)) {
  62                 ob_start();
  63                 if (isset($this->_files['_begin'])) {
  64                     include $this->_file('_begin');
  65                 }
  66                 include $this->_file($tag);
  67                 if (isset($this->_files['_end'])) {
  68                     include $this->_file('_end');
  69                 }
  70                 //return ob_end_clean();
  71             } else {
  72                 ob_start();
  73                 if (isset($this->_files['_begin'])) {
  74                     include $this->_file('_begin');
  75                 }
  76                 $tags = $tag;
  77                 unset($tag);
  78                 foreach ($tags as $tag) {
  79                     include $this->_file($tag);
  80                 }
  81                 if (isset($this->_files['_end'])) {
  82                     include $this->_file('_end');
  83                 }
  84            }
  85            ob_end_flush();
  86         } catch (templates_exception $e) {
  87             die ($e->getMessage());
  88         } catch (Exception $e) { die('ex error: '.$e->getMessage()); }
  89     }
  90
  91     /**
  92      * Check if the template file is readable and returns its name
  93      *
  94      * @param string $tag
  95      */
  96     private function _file($tag) {
  97         if (is_readable($this->_templatePath.$this->_files[$tag])) {
  98             return $this->_templatePath.$this->_files[$tag];
  99         } else {
 100             throw new templates_exception('The file <em>'.$this->_templatePath.$this->_files[$tag]. '</em> is not readable');
 101         }
 102     }
 103
 104     /**
 105      * Used to set some functions who escape the content
 106      *
 107      * @param function $ref
 108      */
 109     public function setEscape($ref) {
 110         if (!in_array($ref,$this->_escape)) {
 111             $this->_escape[] = $ref;
 112         }
 113     }
 114
 115     /**
 116      * Used to remove a function from the pool of escape
 117      */
 118     public function remEscape($ref,$id=false) {
 119         if ($id && isset($this->_escape[$id])) {
 120             unset($this->_escape[$id]);
 121             return true;
 122         } elseif (!$id) {
 123             foreach ($this->_escape as $key => $val) {
 124                 if ($val == $ref) {
 125                     unset($this->_escape[$key]);
 126                     return true;
 127                 }
 128             }
 129         }
 130         return false;
 131     }
 132
 133     public function escape($var) {
 134         foreach($this->_escape as $fnct) {
 135             if (in_array($fnct, array('htmlentities','htmlspecialchars'))) {
 136                 $var = call_user_func($fnct, $var, ENT_COMPAT, 'utf8');
 137             } else {
 138                 $var = call_user_func($fnc, $var);
 139             }
 140         }
 141         return $var;
 142     }
 143
 144     public function __isset($key) {
 145         $strpos = strpos($key,'_');
 146         if (!is_bool($strpos) && $strpos !== 0) {
 147             return isset($this->$key);
 148         }
 149         return false;
 150     }
 151 }