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
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 2, or (at your option)
12 # wfpl is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 # General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with wfpl; see the file COPYING. If not, write to the
19 # Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
23 # This file contains generally useful template handling code. It is wrapped in
24 # an object so that if you want/need to you can make more than one instance of
25 # it and they won't step on each other's toes. Also there are a set of global
26 # functions at the bottom so you don't have to mess around with objects if you
27 # don't want to. The documentation will be on the object methods, but just know
28 # that each has a straight function wrapper at the bottom with 'tem_' prepended
31 # This is designed to be as simple as it can be for your project. The simple
32 # way to use it is to set some key/value pairs with tem_set() then call
33 # tem_output('filename.html') to output the page. A more complex example
34 # including the use of sub-templates can be found in tem_test.php
36 require_once('code/wfpl/encode.php');
37 require_once('code/wfpl/basics.php');
40 var $keyval; # an array containing key/value pairs
41 var $filename; # template filename (sometimes unset)
42 var $template; # contents of template
43 var $sub_templates; # tag-name/template-string pairs
45 # initialize variables
47 $this->keyval = array('' => '~');
48 $this->sub_templates = array();
51 # set a key/value pair. if a ~tag~ in the template matches key it will be replaced by value
52 function set($key, $value) {
53 $this->keyval[$key] = $value;
56 # grab a value you stuck in earlier with set()
58 return $this->keyval[$key];
61 # run the template engine on one of the sub-templates and append the result
62 # to the keyval in the main array. See tem_test.php for an example of how
64 function sub($sub_template_name) {
65 $this->keyval[$sub_template_name] .= template_run($this->sub_templates[$sub_template_name], $this->keyval);
68 # this is used by tem::load() and should be otherwise useless
69 function _load(&$in, &$out) {
71 # scan for one of: 1) the begining of a sub-template 2) the end of this one 3) the end of the file
72 $n = strpos($in, '<!--~');
73 if($n === false) { # not found
74 # we hit the end of the file
80 $out .= substr($in, 0, $n);
81 $in = substr($in, $n);
85 if(strcmp('<!--~end~-->', substr($in, 0, 12)) == 0) {
86 $in = substr($in, 12);
91 # this limits sub_template names to 50 chars
92 if(ereg('<!--~([^~]*) start~-->', substr($in, 0, 65), $matches)) {
93 list($start_tag, $tag_name) = $matches;
94 $out .= '~' . $tag_name . '~';
95 $in = substr($in, strlen($start_tag));
96 $this->sub_templates[$tag_name] = '';
97 $this->_load($in, $this->sub_templates[$tag_name]);
99 # it's not a start tag or end tag, so let's pass it through:
100 $out .= substr($in, 0, 5);
101 $in = substr($in, 5);
106 # This is useful when you have sub-templates that you want to mess with
107 # before the main template is run. But can also be used to simply specify
108 # the filename ahead of time.
109 function load($filename) {
110 $this->filename = $filename;
111 $tmp = read_whole_file($filename);
112 $this->template = '';
113 $this->_load($tmp, $this->template);
116 # Run the template. Pass a filename, or a string, unless you've already
117 # specified a template with load()
118 function run($templ = false) {
119 if($templ !== false) {
120 if(strlen($templ) < 150 && file_exists($templ)) {
121 $this->filename = $templ;
122 unset($this->template);
124 $this->template = $templ;
128 if(!$this->template) {
129 if(!$this->filename) {
130 print "sorry, no template to run\n";
134 $this->template = read_whole_file($this->filename);
137 return template_run($this->template, $this->keyval);
140 # same as run() except the output is print()ed
141 function output($templ = false) {
142 print($this->run($templ));
146 # Below are functions so you can use the above class without allocating or
147 # keeping track of it.
149 # get a reference to the current template object
150 function tem_init() {
151 if(!$GLOBALS['wfpl_template']) {
152 $GLOBALS['wfpl_template'] = new tem();
156 function tem_set($key, $value) {
158 $GLOBALS['wfpl_template']->set($key, $value);
161 function tem_get($key) {
163 return $GLOBALS['wfpl_template']->get($key);
166 function tem_run($templ = false) {
168 return $GLOBALS['wfpl_template']->run($templ);
171 function tem_sub($sub_template_name) {
173 $GLOBALS['wfpl_template']->sub($sub_template_name);
176 function tem_load($filename) {
178 $GLOBALS['wfpl_template']->load($filename);
181 function tem_output($filename = false) {
183 $GLOBALS['wfpl_template']->output($filename);
188 # this is used in template_run() and should be of no other use
189 function template_filler($matches) {
190 list($tag, $enc) = explode('.', $matches[1], 2);
191 $value = $GLOBALS['wfpl_template_keyval'][$tag];
194 if(function_exists($enc)) {
195 $value = $enc($value);
197 print "ERROR: encoder function '$enc' not found.<br>\n";
205 # pass a template string and an associative array of the key/values and it
206 # returns the result.
207 function template_run($template, &$keyval) {
208 $GLOBALS['wfpl_template_keyval'] =& $keyval;
209 return preg_replace_callback(array('|<!--~([^~]*)~-->|', '|~([^~]*)~|', '|<span class="template">([^<]*)</span>|', '|<p class="template">([^<]*)</p>|'), 'template_filler', $template);