Delineating functions
[isso.git] / template_fs.php
1 <?php
2 /*=====================================================================*\
3 || ###################################################################
4 || # Iris Studios Shared Object Framework [#]version[#]
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 * Framework registry object
47 * @var object
48 */
49 var $registry = null;
50
51 /**
52 * The path, from the path of the application, where templates are stored
53 * @var string
54 */
55 var $templatedir = '';
56
57 /**
58 * The extension all the template files have
59 * @var string
60 */
61 var $extension = 'tpl';
62
63 // ###################################################################
64 /**
65 * Constructor
66 */
67 function __construct(&$registry)
68 {
69 $this->registry =& $registry;
70 }
71
72 // ###################################################################
73 /**
74 * (PHP 4) Constructor
75 */
76 function Template_FS(&$registry)
77 {
78 $this->__construct($registry);
79 }
80
81 // ###################################################################
82 /**
83 * Takes an array of template names, loads them, and then stores a
84 * parsed version for optimum speed.
85 *
86 * @access public
87 *
88 * @param array List of template names to be cached
89 */
90 function cache($namearray)
91 {
92 if (sizeof($this->cache) > 0)
93 {
94 trigger_error('You cannot cache templates more than once per initialization', E_USER_WARNING);
95 }
96 else
97 {
98 foreach ($namearray AS $name)
99 {
100 $template = $this->_load($name);
101 $template = $this->_parse($template);
102 $this->cache["$name"] = $template;
103 $this->usage["$name"] = 0;
104 }
105 }
106 }
107
108 // ###################################################################
109 /**
110 * Loads a template from the file system from the specified
111 * $templatedir with the file extension $extension
112 *
113 * @access private
114 *
115 * @param string The name of the template call
116 */
117 function _load($name)
118 {
119 $path = $this->registry->apppath . $this->templatedir . $name . '.' . $this->extension;
120 if (is_file($path))
121 {
122 if (($template = @file_get_contents($path)) !== false)
123 {
124 return $template;
125 }
126 else
127 {
128 trigger_error("Could not load the template '$path'", E_USER_ERROR);
129 exit;
130 }
131 }
132 else
133 {
134 trigger_error("Could not load the template '$path'", E_USER_ERROR);
135 exit;
136 }
137 }
138 }
139
140 /*=====================================================================*\
141 || ###################################################################
142 || # $HeadURL$
143 || # $Id$
144 || ###################################################################
145 \*=====================================================================*/
146 ?>