template_fs.php

   1 <?php
   2 /*=====================================================================*\
   3 || ###################################################################
   4 || # Blue Static ISSO Framework [#]issoversion[#]
   5 || # Copyright ©2002-[#]year[#] Blue Static
   6 || #
   7 || # This program is free software; you can redistribute it and/or modify
   8 || # it under the terms of the GNU General Public License as published by
   9 || # the Free Software Foundation; version [#]gpl[#] of the License.
  10 || #
  11 || # This program is distributed in the hope that it will be useful, but
  12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  14 || # more details.
  15 || #
  16 || # You should have received a copy of the GNU General Public License along
  17 || # with this program; if not, write to the Free Software Foundation, Inc.,
  18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  19 || ###################################################################
  20 \*=====================================================================*/
  21
  22 /**
  23 * File System Template System
  24 * template_fs.php
  25 *
  26 * @package      ISSO
  27 */
  28
  29 $this->load('template', null);
  30
  31 /**
  32 * File System Template System
  33 *
  34 * This framework merely replaces the template loading functions with
  35 * file-system based ones.
  36 *
  37 * @author               Blue Static
  38 * @copyright    Copyright ©2002 - [#]year[#], Blue Static
  39 * @version              $Revision$
  40 * @package              ISSO
  41 *
  42 */
  43 class Template_FS extends Template
  44 {
  45         /**
  46         * The path, from the path of the application, where templates are stored
  47         * @var  string
  48         */
  49         private $templatedir = '';
  50
  51         /**
  52         * The extension all the template files have
  53         * @var  string
  54         */
  55         private $extension = 'tpl';
  56
  57         /**
  58         * Fields array that is used in this module
  59         * @var  array
  60         */
  61         private $fields = array(
  62                 'templatedir'           => array(REQ_YES,       'fetch_sourcepath',     false),
  63                 'extension'                     => array(REQ_YES,       null,                           false),
  64                 'pre_parse_hook'        => array(REQ_NO,        null,   false)
  65         );
  66
  67         // ###################################################################
  68         /**
  69         * Constructor
  70         */
  71         function __construct(&$registry)
  72         {
  73                 $this->registry =& $registry;
  74         }
  75
  76         // ###################################################################
  77         /**
  78         * Sets an ISSO field
  79         *
  80         * @access       public
  81         *
  82         * @param        string  Field name
  83         * @param        mixed   Value of the field
  84         */
  85         function set($name, $value)
  86         {
  87                 $this->registry->do_set($name, $value, 'template_fs');
  88         }
  89
  90         // ###################################################################
  91         /**
  92         * Gets an ISSO field
  93         *
  94         * @access       public
  95         *
  96         * @param        string  Field name
  97         *
  98         * @return       mixed   Value of the field
  99         */
 100         function get($fieldname)
 101         {
 102                 return $this->do_get($fieldname, 'template_fs');
 103         }
 104
 105         // ###################################################################
 106         /**
 107         * Takes an array of template names, loads them, and then stores a
 108         * parsed version for optimum speed.
 109         *
 110         * @access       public
 111         *
 112         * @param        array   List of template names to be cached
 113         */
 114         function cache($namearray)
 115         {
 116                 if (sizeof($this->cache) > 0)
 117                 {
 118                         trigger_error('You cannot cache templates more than once per initialization', E_USER_WARNING);
 119                 }
 120                 else
 121                 {
 122                         foreach ($namearray AS $name)
 123                         {
 124                                 $template = $this->_load($name);
 125                                 $template = $this->_parse($template);
 126                                 $this->cache["$name"] = $template;
 127                                 $this->usage["$name"] = 0;
 128                         }
 129                 }
 130         }
 131
 132         // ###################################################################
 133         /**
 134         * Loads a template from the file system from the specified
 135         * $templatedir with the file extension $extension
 136         *
 137         * @access       private
 138         *
 139         * @param        string  The name of the template call
 140         */
 141         function _load($name)
 142         {
 143                 $this->registry->check_isso_fields(get_class($this));
 144
 145                 $path = $this->registry->apppath . $this->templatedir . $name . '.' . $this->extension;
 146                 if (is_file($path))
 147                 {
 148                         if (($template = @file_get_contents($path)) !== false)
 149                         {
 150                                 return $template;
 151                         }
 152                         else
 153                         {
 154                                 trigger_error("Could not load the template '$path'", E_USER_ERROR);
 155                                 exit;
 156                         }
 157                 }
 158                 else
 159                 {
 160                         trigger_error("Could not load the template '$path'", E_USER_ERROR);
 161                         exit;
 162                 }
 163         }
 164 }
 165
 166 /*=====================================================================*\
 167 || ###################################################################
 168 || # $HeadURL$
 169 || # $Id$
 170 || ###################################################################
 171 \*=====================================================================*/
 172 ?>