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         # like set() but appends
  61         function append($key, $value) {
  62                 $this->keyval[$key] .= $value;
  63         }
  64
  65         # clear a value. Functionally equivalent to set($key, '') but cleaner and more efficient
  66         function clear($key) {
  67                 unset($this->keyval[$key]);
  68         }
  69
  70         # grab a value you stuck in earlier with set()
  71         function get($key) {
  72                 return $this->keyval[$key];
  73         }
  74
  75         # depricated (renamed show())
  76         function sub($sub_template_name) {
  77                 $this->show($sub_template_name);
  78         }
  79
  80         # run the template engine on one of the sub-templates and append the result
  81         # to the keyval in the main array. See tem_test.php for an example of how
  82         # this can be used.
  83         function show($sub_template_name) {
  84                 $this->keyval[$sub_template_name] .= template_run($this->sub_templates[$sub_template_name], $this->keyval);
  85
  86                 # after running a sub-template, clear its sub-templates
  87                 if(isset($this->sub_subs[$sub_template_name])) {
  88                         foreach($this->sub_subs[$sub_template_name] as $sub_sub) {
  89                                 $this->clear($sub_sub);
  90                         }
  91                 }
  92         }
  93
  94         function show_separated($sub_template_name) {
  95                 if($this->get($sub_template_name)) {
  96                         $this->show($sub_template_name . '_sep');
  97                 }
  98                 $this->show($sub_template_name);
  99         }
 100
 101         # this is used by tem::load() and should be otherwise useless
 102         function _load(&$in, &$out, &$parents, &$parent) {
 103                 while($in) {
 104                         # scan for one of: 1) the begining of a sub-template 2) the end of this one 3) the end of the file
 105                         $n = strpos($in, '<!--~');
 106                         if($n === false) { # not found
 107                                 # we hit the end of the file
 108                                 $out .= $in;
 109                                 $in = '';
 110                                 return;
 111                         }
 112
 113                         # move everything up to (but not including) <!-- to the output
 114                         $out .= substr($in, 0, $n);
 115                         $in = substr($in, $n);
 116
 117                         # we found something.
 118                         # is it an end tag?
 119                         if(strcmp('<!--~end~-->', substr($in, 0, 12)) == 0) {
 120                                 $in = substr($in, 12);
 121                                 $parent = array_pop($parents);
 122                                 return;
 123                         }
 124
 125                         $matches = array();
 126                         # this limits sub_template names to 50 chars
 127                         if(ereg('^<!--~([^~]*) start~-->', substr($in, 0, 65), $matches)) {
 128                                 list($start_tag, $tag_name) = $matches;
 129
 130                                 # keep track of the tree
 131                                 if(!isset($this->sub_subs[$parent])) {
 132                                         $this->sub_subs[$parent] = array();
 133                                 }
 134                                 array_push($this->sub_subs[$parent], $tag_name);
 135                                 array_push($parents, $parent);
 136                                 $parent = $tag_name;
 137
 138                                 $out .= '~' . $tag_name . '~';
 139                                 $in = substr($in, strlen($start_tag));
 140                                 $this->sub_templates[$tag_name] = '';
 141                                 $this->_load($in, $this->sub_templates[$tag_name], $parents, $parent);
 142                         } else {
 143                                 # it's not a start tag or end tag, so let's pass it through:
 144                                 $out .= substr($in, 0, 5);
 145                                 $in = substr($in, 5);
 146                         }
 147                 } #repeat
 148         }
 149
 150         # like load() except you pass a string instead of a filename
 151         function load_str($str) {
 152                 $this->template = '';
 153                 $parents = array('top_level_subs' => array());
 154                 $parent = 'top_level_subs';
 155                 $this->_load($str, $this->template, $parents, $parent);
 156         }
 157
 158         # This is useful when you have sub-templates that you want to mess with
 159         # before the main template is run. But can also be used to simply specify
 160         # the filename ahead of time.
 161         function load($filename) {
 162                 $this->filename = $filename;
 163                 $this->load_str(read_whole_file($filename));
 164         }
 165
 166         # Run the template. Pass a filename, or a string, unless you've already
 167         # specified a template with load()
 168         function run($templ = false) {
 169                 $template_string = $this->template;
 170                 $template_file = $this->file;
 171                 if($templ !== false) {
 172                         if(strlen($templ) < 150 && file_exists($templ)) {
 173                                 $template_file = $templ;
 174                                 unset($template_string);
 175                         } else {
 176                                 $template_string = $templ;
 177                         }
 178                 }
 179
 180                 if(!$template_string) {
 181                         if(!$template_file) {
 182                                 print "sorry, no template to run\n";
 183                                 exit(1);
 184                         }
 185
 186                         $template_string = read_whole_file($template_file);
 187                 }
 188
 189                 return template_run($template_string, $this->keyval);
 190         }
 191
 192         # same as run() except the output is print()ed
 193         function output($templ = false) {
 194                 print($this->run($templ));
 195         }
 196
 197         # return the names of the top level subs, or an empty array
 198         function top_sub_names() {
 199                 if(isset($this->sub_subs['top_level_subs'])) {
 200                         return $this->sub_subs['top_level_subs'];
 201                 } else {
 202                         return array();
 203                 }
 204         }
 205
 206         # return the contents of the top-level sub-templates
 207         #
 208         # this does not run the sub-templates, so if you've not called tem_show() on them, they will be blank.
 209         #
 210         # Return a hash.
 211         #     keys: name of top level sub-template.
 212         #     values: contents of said sub-template.
 213         function top_subs() {
 214                 $ret = array();
 215                 $names = $this->top_sub_names();
 216                 foreach($names as $name) {
 217                         $ret[$name] = $this->get($name);
 218                 }
 219                 return $ret;
 220         }
 221 }
 222
 223 # Below are functions so you can use the above class without allocating or
 224 # keeping track of it.
 225
 226 # get a reference to the current template object
 227 function tem_init() {
 228         if(!$GLOBALS['wfpl_template']) {
 229                 $GLOBALS['wfpl_template'] = new tem();
 230         }
 231 }
 232
 233 function tem_append($key, $value) {
 234         tem_init();
 235         $GLOBALS['wfpl_template']->append($key, $value);
 236 }
 237
 238 function tem_set($key, $value) {
 239         tem_init();
 240         $GLOBALS['wfpl_template']->set($key, $value);
 241 }
 242
 243 function tem_get($key) {
 244         tem_init();
 245         return $GLOBALS['wfpl_template']->get($key);
 246 }
 247
 248 function tem_run($templ = false) {
 249         tem_init();
 250         return $GLOBALS['wfpl_template']->run($templ);
 251 }
 252
 253 # depricated (renamed tem_show())
 254 function tem_sub($sub_template_name) {
 255         tem_show($sub_template_name);
 256 }
 257
 258 function tem_show($sub_template_name) {
 259         tem_init();
 260         $GLOBALS['wfpl_template']->show($sub_template_name);
 261 }
 262
 263 function tem_show_separated($sub_template_name) {
 264         tem_init();
 265         $GLOBALS['wfpl_template']->show_separated($sub_template_name);
 266 }
 267
 268
 269 function tem_load($filename) {
 270         tem_init();
 271         $GLOBALS['wfpl_template']->load($filename);
 272 }
 273
 274 function tem_output($filename = false) {
 275         tem_init();
 276         $GLOBALS['wfpl_template']->output($filename);
 277 }
 278
 279
 280
 281 # this is used in template_run() and should be of no other use
 282 function template_filler($matches) {
 283         list($tag, $enc) = explode('.', $matches[1], 2);
 284         $value = $GLOBALS['wfpl_template_keyval'][$tag];
 285         if($enc) {
 286                 $encs = explode('.', $enc);
 287                 foreach($encs as $enc) {
 288                         $enc = "enc_$enc";
 289                         if(function_exists($enc)) {
 290                                 $value = $enc($value, $tag);
 291                         } else {
 292                                 print "ERROR: encoder function '$enc' not found.<br>\n";
 293                                 exit(1);
 294                         }
 295                 }
 296         }
 297         return $value;
 298 }
 299
 300
 301 # pass a template string and an associative array of the key/values and it
 302 # returns the result.
 303 function template_run($template, &$keyval) {
 304         $GLOBALS['wfpl_template_keyval'] =& $keyval;
 305         return preg_replace_callback(array('|<!--~([^~]*)~-->|', '|~([^~]*)~|', '|<span class="template">([^<]*)</span>|', '|<p class="template">([^<]*)</p>|'), 'template_filler', $template);
 306 }
 307
 308 function tem_top_sub_names() {
 309         tem_init();
 310         return $GLOBALS['wfpl_template']->top_sub_names();
 311 }
 312
 313 function tem_top_subs() {
 314         tem_init();
 315         return $GLOBALS['wfpl_template']->top_subs();
 316 }
 317
 318 # replaces currently set template, and returns the old.
 319 function tem_load_new($file) {
 320         $old = $GLOBALS['wfpl_template'];
 321         $GLOBALS['wfpl_template'] = new tem();
 322         $GLOBALS['wfpl_template']->load($file);
 323         return $old;
 324 }
 325
 326 ?>