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         public function __construct(&$registry)
  72         {
  73                 $this->registry =& $registry;
  74         }
  75
  76         // ###################################################################
  77         /**
  78         * Sets an ISSO field
  79         *
  80         * @param        string  Field name
  81         * @param        mixed   Value of the field
  82         */
  83         public function set($name, $value)
  84         {
  85                 $this->registry->do_set($name, $value, 'template_fs');
  86         }
  87
  88         // ###################################################################
  89         /**
  90         * Gets an ISSO field
  91         *
  92         * @param        string  Field name
  93         *
  94         * @return       mixed   Value of the field
  95         */
  96         public function get($fieldname)
  97         {
  98                 return $this->do_get($fieldname, 'template_fs');
  99         }
 100
 101         // ###################################################################
 102         /**
 103         * Takes an array of template names, loads them, and then stores a
 104         * parsed version for optimum speed.
 105         *
 106         * @param        array   List of template names to be cached
 107         */
 108         public function cache($namearray)
 109         {
 110                 if (sizeof($this->cache) > 0)
 111                 {
 112                         trigger_error('You cannot cache templates more than once per initialization', E_USER_WARNING);
 113                 }
 114                 else
 115                 {
 116                         foreach ($namearray AS $name)
 117                         {
 118                                 $template = $this->_load($name);
 119                                 $template = $this->_parse($template);
 120                                 $this->cache["$name"] = $template;
 121                                 $this->usage["$name"] = 0;
 122                         }
 123                 }
 124         }
 125
 126         // ###################################################################
 127         /**
 128         * Loads a template from the file system from the specified
 129         * $templatedir with the file extension $extension
 130         *
 131         * @param        string  The name of the template call
 132         */
 133         private function _load($name)
 134         {
 135                 $this->registry->check_isso_fields(get_class($this));
 136
 137                 $path = $this->registry->apppath . $this->templatedir . $name . '.' . $this->extension;
 138                 if (is_file($path))
 139                 {
 140                         if (($template = @file_get_contents($path)) !== false)
 141                         {
 142                                 return $template;
 143                         }
 144                         else
 145                         {
 146                                 trigger_error("Could not load the template '$path'", E_USER_ERROR);
 147                                 exit;
 148                         }
 149                 }
 150                 else
 151                 {
 152                         trigger_error("Could not load the template '$path'", E_USER_ERROR);
 153                         exit;
 154                 }
 155         }
 156 }
 157
 158 /*=====================================================================*\
 159 || ###################################################################
 160 || # $HeadURL$
 161 || # $Id$
 162 || ###################################################################
 163 \*=====================================================================*/
 164 ?>