template_fs.php

   1 <?php
   2 /*=====================================================================*\
   3 || ###################################################################
   4 || # Iris Studios Shared Object Framework [#]issoversion[#]
   5 || # Copyright ©2002-[#]year[#] Iris Studios, Inc.
   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               Iris Studios, Inc.
  38 * @copyright    Copyright ©2002 - [#]year[#], Iris Studios, Inc.
  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         * @access       private
  49         */
  50         var $templatedir = '';
  51
  52         /**
  53         * The extension all the template files have
  54         * @var  string
  55         * @access       private
  56         */
  57         var $extension = 'tpl';
  58
  59         /**
  60         * Fields array that is used in this module
  61         * @var  array
  62         * @access       private
  63         */
  64         var $fields = array(
  65                 'templatedir'   => array(REQ_YES,       'fetch_sourcepath',     false),
  66                 'extension'             => array(REQ_YES,       null,                           false)
  67         );
  68
  69         // ###################################################################
  70         /**
  71         * Constructor
  72         */
  73         function __construct(&$registry)
  74         {
  75                 $this->registry =& $registry;
  76         }
  77
  78         // ###################################################################
  79         /**
  80         * (PHP 4) Constructor
  81         */
  82         function Template_FS(&$registry)
  83         {
  84                 $this->__construct($registry);
  85         }
  86
  87         // ###################################################################
  88         /**
  89         * Sets an ISSO field
  90         *
  91         * @access       public
  92         *
  93         * @param        string  Field name
  94         * @param        mixed   Value of the field
  95         */
  96         function set($name, $value)
  97         {
  98                 $this->registry->do_set($name, $value, 'template_fs');
  99         }
 100
 101         // ###################################################################
 102         /**
 103         * Gets an ISSO field
 104         *
 105         * @access       public
 106         *
 107         * @param        string  Field name
 108         *
 109         * @return       mixed   Value of the field
 110         */
 111         function get($fieldname)
 112         {
 113                 return $this->do_get($fieldname, 'template_fs');
 114         }
 115
 116         // ###################################################################
 117         /**
 118         * Takes an array of template names, loads them, and then stores a
 119         * parsed version for optimum speed.
 120         *
 121         * @access       public
 122         *
 123         * @param        array   List of template names to be cached
 124         */
 125         function cache($namearray)
 126         {
 127                 if (sizeof($this->cache) > 0)
 128                 {
 129                         trigger_error('You cannot cache templates more than once per initialization', E_USER_WARNING);
 130                 }
 131                 else
 132                 {
 133                         foreach ($namearray AS $name)
 134                         {
 135                                 $template = $this->_load($name);
 136                                 $template = $this->_parse($template);
 137                                 $this->cache["$name"] = $template;
 138                                 $this->usage["$name"] = 0;
 139                         }
 140                 }
 141         }
 142
 143         // ###################################################################
 144         /**
 145         * Loads a template from the file system from the specified
 146         * $templatedir with the file extension $extension
 147         *
 148         * @access       private
 149         *
 150         * @param        string  The name of the template call
 151         */
 152         function _load($name)
 153         {
 154                 $this->registry->check_isso_fields(get_class($this));
 155
 156                 $path = $this->registry->apppath . $this->templatedir . $name . '.' . $this->extension;
 157                 if (is_file($path))
 158                 {
 159                         if (($template = @file_get_contents($path)) !== false)
 160                         {
 161                                 return $template;
 162                         }
 163                         else
 164                         {
 165                                 trigger_error("Could not load the template '$path'", E_USER_ERROR);
 166                                 exit;
 167                         }
 168                 }
 169                 else
 170                 {
 171                         trigger_error("Could not load the template '$path'", E_USER_ERROR);
 172                         exit;
 173                 }
 174         }
 175 }
 176
 177 /*=====================================================================*\
 178 || ###################################################################
 179 || # $HeadURL$
 180 || # $Id$
 181 || ###################################################################
 182 \*=====================================================================*/
 183 ?>