3 # Copyright (C) 2005 Jason Woofenden
5 # This file is part of wfpl.
7 # wfpl is free software; you can redistribute it and/or modify it under the
8 # terms of the GNU Lesser General Public License as published by the Free
9 # Software Foundation; either version 2.1 of the License, or (at your option)
12 # wfpl is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
14 # FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
17 # You should have received a copy of the GNU Lesser General Public License
18 # along with wfpl; if not, write to the Free Software Foundation, Inc., 51
19 # Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 # This file contains generally useful template handling code. It is wrapped in
23 # an object so that if you want/need to you can make more than one instance of
24 # it and they won't step on each other's toes. Also there are a set of global
25 # functions at the bottom so you don't have to mess around with objects if you
26 # don't want to. The documentation will be on the object methods, but just know
27 # that each has a straight function wrapper at the bottom with 'tem_' prepended
30 # This is designed to be as simple as it can be for your project. The simple
31 # way to use it is to set some key/value pairs with tem_set() then call
32 # tem_output('filename.html') to output the page. A more complex example
33 # including the use of sub-templates can be found in tem_test.php
35 # FIXME: sub-sub templates need to be cleared when the sub template containing
38 require_once('code/wfpl/encode.php');
39 require_once('code/wfpl/misc.php');
40 require_once('code/wfpl/file.php');
43 var $keyval; # an array containing key/value pairs
44 var $filename; # template filename (sometimes not set)
45 var $template; # contents of template
46 var $sub_templates; # tag-name/template-string pairs
47 var $sub_subs; # key: sub-template name value: array of names of the sub-templates of this one
49 # initialize variables
51 $this->keyval = array('' => '~'); # so that ~~ in the template creates a single ~
52 $this->sub_templates = array();
55 # set a key/value pair. if a ~tag~ in the template matches key it will be replaced by value
56 function set($key, $value) {
57 $this->keyval[$key] = $value;
60 # like set() but appends
61 function append($key, $value) {
62 $this->keyval[$key] .= $value;
65 # like set() but prepends
66 function prepend($key, $value) {
67 $this->keyval[$key] = $value . $this->keyval[$key];
70 # clear a value. Functionally equivalent to set($key, '') but cleaner and more efficient
71 function clear($key) {
72 unset($this->keyval[$key]);
75 # grab a value you stuck in earlier with set()
77 return $this->keyval[$key];
80 # depricated (renamed show())
81 function sub($sub_template_name) {
82 $this->show($sub_template_name);
85 # run the template engine on one of the sub-templates and append the result
86 # to the keyval in the main array. See tem_test.php for an example of how
88 function show($sub_template_name) {
89 $this->keyval[$sub_template_name] .= template_run($this->sub_templates[$sub_template_name], $this->keyval);
91 # after running a sub-template, clear its sub-templates
92 if(isset($this->sub_subs[$sub_template_name])) {
93 foreach($this->sub_subs[$sub_template_name] as $sub_sub) {
94 $this->clear($sub_sub);
99 function show_separated($sub_template_name) {
100 if($this->get($sub_template_name)) {
101 $this->show($sub_template_name . '_sep');
103 $this->show($sub_template_name);
106 # this is used by tem::load() and should be otherwise useless
107 function _load(&$in, &$out, &$parents, &$parent) {
109 # scan for one of: 1) the begining of a sub-template 2) the end of this one 3) the end of the file
110 $n = strpos($in, '<!--~');
111 if($n === false) { # not found
112 # we hit the end of the file
118 # move everything up to (but not including) <!-- to the output
119 $out .= substr($in, 0, $n);
120 $in = substr($in, $n);
122 # we found something.
124 if(strcmp('<!--~end~-->', substr($in, 0, 12)) == 0) {
125 $in = substr($in, 12);
126 $parent = array_pop($parents);
131 # this limits sub_template names to 50 chars
132 if(ereg('^<!--~([^~]*) start~-->', substr($in, 0, 65), $matches)) {
133 list($start_tag, $tag_name) = $matches;
135 # keep track of the tree
136 if(!isset($this->sub_subs[$parent])) {
137 $this->sub_subs[$parent] = array();
139 array_push($this->sub_subs[$parent], $tag_name);
140 array_push($parents, $parent);
143 $out .= '~' . $tag_name . '~';
144 $in = substr($in, strlen($start_tag));
145 $this->sub_templates[$tag_name] = '';
146 $this->_load($in, $this->sub_templates[$tag_name], $parents, $parent);
148 # it's not a start tag or end tag, so let's pass it through:
149 $out .= substr($in, 0, 5);
150 $in = substr($in, 5);
155 # like load() except you pass a string instead of a filename
156 function load_str($str) {
157 $this->template = '';
158 $parents = array('top_level_subs' => array());
159 $parent = 'top_level_subs';
160 $this->_load($str, $this->template, $parents, $parent);
163 # This is useful when you have sub-templates that you want to mess with
164 # before the main template is run. But can also be used to simply specify
165 # the filename ahead of time.
166 function load($filename) {
167 $this->filename = $filename;
168 $this->load_str(read_whole_file($filename));
171 # Run the template. Pass a filename, or a string, unless you've already
172 # specified a template with load()
173 function run($templ = false) {
174 $template_string = $this->template;
175 $template_file = $this->file;
176 if($templ !== false) {
177 if(strlen($templ) < 150 && file_exists($templ)) {
178 $template_file = $templ;
179 unset($template_string);
181 $template_string = $templ;
185 if(!$template_string) {
186 if(!$template_file) {
187 print "sorry, no template to run\n";
191 $template_string = read_whole_file($template_file);
194 return template_run($template_string, $this->keyval);
197 # same as run() except the output is print()ed
198 function output($templ = false) {
199 print($this->run($templ));
202 # return the names of the top level subs, or an empty array
203 function top_sub_names() {
204 if(isset($this->sub_subs['top_level_subs'])) {
205 return $this->sub_subs['top_level_subs'];
211 # return the contents of the top-level sub-templates
213 # this does not run the sub-templates, so if you've not called tem_show() on them, they will be blank.
216 # keys: name of top level sub-template.
217 # values: contents of said sub-template.
218 function top_subs() {
220 $names = $this->top_sub_names();
221 foreach($names as $name) {
222 $ret[$name] = $this->get($name);
228 # Below are functions so you can use the above class without allocating or
229 # keeping track of it.
231 # get a reference to the current template object
232 function tem_init() {
233 if(!$GLOBALS['wfpl_template']) {
234 $GLOBALS['wfpl_template'] = new tem();
238 function tem_append($key, $value) {
240 $GLOBALS['wfpl_template']->append($key, $value);
243 function tem_prepend($key, $value) {
245 $GLOBALS['wfpl_template']->prepend($key, $value);
248 function tem_set($key, $value) {
250 $GLOBALS['wfpl_template']->set($key, $value);
253 function tem_get($key) {
255 return $GLOBALS['wfpl_template']->get($key);
258 function tem_run($templ = false) {
260 return $GLOBALS['wfpl_template']->run($templ);
263 # depricated (renamed tem_show())
264 function tem_sub($sub_template_name) {
265 tem_show($sub_template_name);
268 function tem_show($sub_template_name) {
270 $GLOBALS['wfpl_template']->show($sub_template_name);
273 function tem_show_separated($sub_template_name) {
275 $GLOBALS['wfpl_template']->show_separated($sub_template_name);
279 function tem_load($filename) {
281 $GLOBALS['wfpl_template']->load($filename);
284 function tem_output($filename = false) {
286 $GLOBALS['wfpl_template']->output($filename);
291 # this is used in template_run() and should be of no other use
292 function template_filler($matches) {
293 list($tag, $enc) = explode('.', $matches[1], 2);
294 $value = $GLOBALS['wfpl_template_keyval'][$tag];
296 $encs = explode('.', $enc);
297 foreach($encs as $enc) {
299 if(function_exists($enc)) {
300 $value = $enc($value, $tag);
302 print "ERROR: encoder function '$enc' not found.<br>\n";
311 # pass a template string and an associative array of the key/values and it
312 # returns the result.
313 function template_run($template, &$keyval) {
314 $GLOBALS['wfpl_template_keyval'] =& $keyval;
315 return preg_replace_callback(array('|<!--~([^~]*)~-->|', '|~([^~]*)~|', '|<span class="template">([^<]*)</span>|', '|<p class="template">([^<]*)</p>|'), 'template_filler', $template);
318 function tem_top_sub_names() {
320 return $GLOBALS['wfpl_template']->top_sub_names();
323 function tem_top_subs() {
325 return $GLOBALS['wfpl_template']->top_subs();
328 # replaces currently set template, and returns the old.
329 function tem_load_new($file) {
330 $old = $GLOBALS['wfpl_template'];
331 $GLOBALS['wfpl_template'] = new tem();
332 $GLOBALS['wfpl_template']->load($file);