Merging isso-2-dev branch back to trunk
[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 * Constructor
65 */
66 function Template_FS(&$registry)
67 {
68 $this->registry =& $registry;
69 }
70
71 /**
72 * Takes an array of template names, loads them, and then stores
73 * a parsed version for optimum speed.
74 *
75 * @param array List of template names to be cached
76 */
77 function cache($namearray)
78 {
79 if (sizeof($this->cache) > 0)
80 {
81 trigger_error('You cannot cache templates more than once per initialization', E_USER_WARNING);
82 }
83 else
84 {
85 foreach ($namearray AS $name)
86 {
87 $template = $this->_load($name);
88 $template = $this->_parse($template);
89 $this->cache["$name"] = $template;
90 $this->usage["$name"] = 0;
91 }
92 }
93 }
94
95 /**
96 * Loads a template from the file system from the specified $templatedir
97 * with the file extension $extension
98 *
99 * @param string The name of the template call
100 */
101 function _load($name)
102 {
103 $path = $this->registry->apppath . $this->templatedir . $name . '.' . $this->extension;
104 if (is_file($path))
105 {
106 if (($template = @file_get_contents($path)) !== false)
107 {
108 return $template;
109 }
110 else
111 {
112 trigger_error("Could not load the template '$path'", E_USER_ERROR);
113 exit;
114 }
115 }
116 else
117 {
118 trigger_error("Could not load the template '$path'", E_USER_ERROR);
119 exit;
120 }
121 }
122 }
123
124 /*=====================================================================*\
125 || ###################################################################
126 || # $HeadURL$
127 || # $Id$
128 || ###################################################################
129 \*=====================================================================*/
130 ?>