template.php

   1 <?php
   2
   3 #  Copyright (C) 2005 Jason Woofenden
   4 #
   5 #  This file is part of wfpl.
   6 #
   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)
  10 #  any later version.
  11 #
  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
  15 #  more details.
  16 #
  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
  20
  21
  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
  28 # to the name.
  29
  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
  34
  35 # FIXME: sub-sub templates need to be cleared when the sub template containing
  36 # them is run
  37
  38 require_once('code/wfpl/encode.php');
  39 require_once('code/wfpl/misc.php');
  40 require_once('code/wfpl/file.php');
  41
  42 class tem {
  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
  48
  49         # initialize variables
  50         function tem() {
  51                 $this->keyval = array('' => '~'); # so that ~~ in the template creates a single ~
  52                 $this->sub_templates = array();
  53         }
  54
  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;
  58         }
  59
  60         # clear a value. Functionally equivalent to set($key, '') but cleaner and more efficient
  61         function clear($key) {
  62                 unset($this->keyval[$key]);
  63         }
  64
  65         # grab a value you stuck in earlier with set()
  66         function get($key) {
  67                 return $this->keyval[$key];
  68         }
  69
  70         # run the template engine on one of the sub-templates and append the result
  71         # to the keyval in the main array. See tem_test.php for an example of how
  72         # this can be used.
  73         function sub($sub_template_name) {
  74                 $this->keyval[$sub_template_name] .= template_run($this->sub_templates[$sub_template_name], $this->keyval);
  75
  76                 # after running a sub-template, clear its sub-templates
  77                 if(isset($this->sub_subs[$sub_template_name])) {
  78                         foreach($this->sub_subs[$sub_template_name] as $sub_sub) {
  79                                 $this->clear($sub_sub);
  80                         }
  81                 }
  82         }
  83
  84         # this is used by tem::load() and should be otherwise useless
  85         function _load(&$in, &$out, &$parents, &$parent) {
  86                 while($in) {
  87                         # scan for one of: 1) the begining of a sub-template 2) the end of this one 3) the end of the file
  88                         $n = strpos($in, '<!--~');
  89                         if($n === false) { # not found
  90                                 # we hit the end of the file
  91                                 $out .= $in;
  92                                 $in = '';
  93                                 return;
  94                         }
  95
  96                         # move everything up to (but not including) <!-- to the output
  97                         $out .= substr($in, 0, $n);
  98                         $in = substr($in, $n);
  99
 100                         # we found something.
 101                         # is it an end tag?
 102                         if(strcmp('<!--~end~-->', substr($in, 0, 12)) == 0) {
 103                                 $in = substr($in, 12);
 104                                 $parent = array_pop($parents);
 105                                 return;
 106                         }
 107
 108                         $matches = array();
 109                         # this limits sub_template names to 50 chars
 110                         if(ereg('^<!--~([^~]*) start~-->', substr($in, 0, 65), $matches)) {
 111                                 list($start_tag, $tag_name) = $matches;
 112
 113                                 # keep track of the tree
 114                                 if(!isset($this->sub_subs[$parent])) {
 115                                         $this->sub_subs[$parent] = array();
 116                                 }
 117                                 array_push($this->sub_subs[$parent], $tag_name);
 118                                 array_push($parents, $parent);
 119                                 $parent = $tag_name;
 120
 121                                 $out .= '~' . $tag_name . '~';
 122                                 $in = substr($in, strlen($start_tag));
 123                                 $this->sub_templates[$tag_name] = '';
 124                                 $this->_load($in, $this->sub_templates[$tag_name], $parents, $parent);
 125                         } else {
 126                                 # it's not a start tag or end tag, so let's pass it through:
 127                                 $out .= substr($in, 0, 5);
 128                                 $in = substr($in, 5);
 129                         }
 130                 } #repeat
 131         }
 132
 133         # This is useful when you have sub-templates that you want to mess with
 134         # before the main template is run. But can also be used to simply specify
 135         # the filename ahead of time.
 136         function load($filename) {
 137                 $this->filename = $filename;
 138                 $tmp = read_whole_file($filename);
 139                 $this->template = '';
 140                 $parents = array('top_level_subs' => array());
 141                 $parent = 'top_level_subs';
 142                 $this->_load($tmp, $this->template, $parents, $parent);
 143         }
 144
 145         # Run the template. Pass a filename, or a string, unless you've already
 146         # specified a template with load()
 147         function run($templ = false) {
 148                 $template_string = $this->template;
 149                 $template_file = $this->file;
 150                 if($templ !== false) {
 151                         if(strlen($templ) < 150 && file_exists($templ)) {
 152                                 $template_file = $templ;
 153                                 unset($template_string);
 154                         } else {
 155                                 $template_string = $templ;
 156                         }
 157                 }
 158
 159                 if(!$template_string) {
 160                         if(!$template_file) {
 161                                 print "sorry, no template to run\n";
 162                                 exit(1);
 163                         }
 164
 165                         $template_string = read_whole_file($template_file);
 166                 }
 167
 168                 return template_run($this->template, $this->keyval);
 169         }
 170
 171         # same as run() except the output is print()ed
 172         function output($templ = false) {
 173                 print($this->run($templ));
 174         }
 175
 176         # return the contents of the top-level sub-templates
 177         #
 178         # this does not run the sub-templates, so if you've not called tem_sub() on them, they will be blank.
 179         #
 180         # Return a hash.
 181         #     keys: name of top level sub-template.
 182         #     values: contents of said sub-template.
 183         function top_subs() {
 184                 $ret = array();
 185                 if(isset($this->sub_subs['top_level_subs'])) {
 186                         foreach($this->sub_subs['top_level_subs'] as $name) {
 187                                 $ret[$name] = $this->get($name);
 188                         }
 189                 }
 190                 return $ret;
 191         }
 192 }
 193
 194 # Below are functions so you can use the above class without allocating or
 195 # keeping track of it.
 196
 197 # get a reference to the current template object
 198 function tem_init() {
 199         if(!$GLOBALS['wfpl_template']) {
 200                 $GLOBALS['wfpl_template'] = new tem();
 201         }
 202 }
 203
 204 function tem_set($key, $value) {
 205         tem_init();
 206         $GLOBALS['wfpl_template']->set($key, $value);
 207 }
 208
 209 function tem_get($key) {
 210         tem_init();
 211         return $GLOBALS['wfpl_template']->get($key);
 212 }
 213
 214 function tem_run($templ = false) {
 215         tem_init();
 216         return $GLOBALS['wfpl_template']->run($templ);
 217 }
 218
 219 function tem_sub($sub_template_name) {
 220         tem_init();
 221         $GLOBALS['wfpl_template']->sub($sub_template_name);
 222 }
 223
 224 function tem_load($filename) {
 225         tem_init();
 226         $GLOBALS['wfpl_template']->load($filename);
 227 }
 228
 229 function tem_output($filename = false) {
 230         tem_init();
 231         $GLOBALS['wfpl_template']->output($filename);
 232 }
 233
 234
 235
 236 # this is used in template_run() and should be of no other use
 237 function template_filler($matches) {
 238         list($tag, $enc) = explode('.', $matches[1], 2);
 239         $value = $GLOBALS['wfpl_template_keyval'][$tag];
 240         if($enc) {
 241                 $encs = explode('.', $enc);
 242                 foreach($encs as $enc) {
 243                         $enc = "enc_$enc";
 244                         if(function_exists($enc)) {
 245                                 $value = $enc($value);
 246                         } else {
 247                                 print "ERROR: encoder function '$enc' not found.<br>\n";
 248                                 exit(1);
 249                         }
 250                 }
 251         }
 252         return $value;
 253 }
 254
 255
 256 # pass a template string and an associative array of the key/values and it
 257 # returns the result.
 258 function template_run($template, &$keyval) {
 259         $GLOBALS['wfpl_template_keyval'] =& $keyval;
 260         return preg_replace_callback(array('|<!--~([^~]*)~-->|', '|~([^~]*)~|', '|<span class="template">([^<]*)</span>|', '|<p class="template">([^<]*)</p>|'), 'template_filler', $template);
 261 }
 262
 263 function tem_top_subs() {
 264         tem_init();
 265         return $GLOBALS['wfpl_template']->top_subs();
 266 }
 267
 268 ?>