X-Git-Url: https://jasonwoof.com/gitweb/?a=blobdiff_plain;f=template.php;h=24252757a919ab5e1a25bc1bc317d3dfb76c1e5a;hb=7add2ea3f61e40c5f0f5539ac6e02533c9390db4;hp=c56e7436236b4f305565ccc9caccde0525768888;hpb=3bec0ef771d741361c6c4c4c1ff069398f6e37a0;p=wfpl.git diff --git a/template.php b/template.php index c56e743..2425275 100644 --- a/template.php +++ b/template.php @@ -4,20 +4,19 @@ # # This file is part of wfpl. # -# wfpl is free software; you can redistribute it and/or modify it -# under the terms of the GNU General Public License as published by -# the Free Software Foundation; either version 2, or (at your option) +# wfpl is free software; you can redistribute it and/or modify it under the +# terms of the GNU Lesser General Public License as published by the Free +# Software Foundation; either version 2.1 of the License, or (at your option) # any later version. # -# wfpl is distributed in the hope that it will be useful, but -# WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# General Public License for more details. +# wfpl is distributed in the hope that it will be useful, but WITHOUT ANY +# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for +# more details. # -# You should have received a copy of the GNU General Public License -# along with wfpl; see the file COPYING. If not, write to the -# Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, -# MA 02111-1307, USA. +# You should have received a copy of the GNU Lesser General Public License +# along with wfpl; if not, write to the Free Software Foundation, Inc., 51 +# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA # This file contains generally useful template handling code. It is wrapped in @@ -33,17 +32,23 @@ # tem_output('filename.html') to output the page. A more complex example # including the use of sub-templates can be found in tem_test.php +# FIXME: sub-sub templates need to be cleared when the sub template containing +# them is run + require_once('code/wfpl/encode.php'); +require_once('code/wfpl/misc.php'); +require_once('code/wfpl/file.php'); class tem { var $keyval; # an array containing key/value pairs - var $filename; # template filename (sometimes unset) + var $filename; # template filename (sometimes not set) var $template; # contents of template var $sub_templates; # tag-name/template-string pairs + var $sub_subs; # key: sub-template name value: array of names of the sub-templates of this one # initialize variables function tem() { - $this->keyval = array('' => '~'); + $this->keyval = array('' => '~'); # so that ~~ in the template creates a single ~ $this->sub_templates = array(); } @@ -52,6 +57,11 @@ class tem { $this->keyval[$key] = $value; } + # clear a value. Functionally equivalent to set($key, '') but cleaner and more efficient + function clear($key) { + unset($this->keyval[$key]); + } + # grab a value you stuck in earlier with set() function get($key) { return $this->keyval[$key]; @@ -62,10 +72,17 @@ class tem { # this can be used. function sub($sub_template_name) { $this->keyval[$sub_template_name] .= template_run($this->sub_templates[$sub_template_name], $this->keyval); + + # after running a sub-template, clear its sub-templates + if(isset($this->sub_subs[$sub_template_name])) { + foreach($this->sub_subs[$sub_template_name] as $sub_sub) { + $this->clear($sub_sub); + } + } } # this is used by tem::load() and should be otherwise useless - function _load(&$in, &$out) { + function _load(&$in, &$out, &$parents, &$parent) { while($in) { # scan for one of: 1) the begining of a sub-template 2) the end of this one 3) the end of the file $n = strpos($in, '', substr($in, 0, 12)) == 0) { $in = substr($in, 12); + $parent = array_pop($parents); return; } $matches = array(); # this limits sub_template names to 50 chars - if(ereg('', substr($in, 0, 65), $matches)) { + if(ereg('^', substr($in, 0, 65), $matches)) { list($start_tag, $tag_name) = $matches; + + # keep track of the tree + if(!isset($this->sub_subs[$parent])) { + $this->sub_subs[$parent] = array(); + } + array_push($this->sub_subs[$parent], $tag_name); + array_push($parents, $parent); + $parent = $tag_name; + $out .= '~' . $tag_name . '~'; $in = substr($in, strlen($start_tag)); $this->sub_templates[$tag_name] = ''; - $this->_load($in, $this->sub_templates[$tag_name]); + $this->_load($in, $this->sub_templates[$tag_name], $parents, $parent); } else { # it's not a start tag or end tag, so let's pass it through: $out .= substr($in, 0, 5); @@ -102,44 +130,69 @@ class tem { } #repeat } + # like load() except you pass a string instead of a filename + function load_str($str) { + $this->template = ''; + $parents = array('top_level_subs' => array()); + $parent = 'top_level_subs'; + $this->_load($str, $this->template, $parents, $parent); + } + # This is useful when you have sub-templates that you want to mess with # before the main template is run. But can also be used to simply specify # the filename ahead of time. function load($filename) { $this->filename = $filename; - $tmp = read_whole_file($filename); - $this->template = ''; - $this->_load($tmp, $this->template); + $this->load_str(read_whole_file($filename)); } # Run the template. Pass a filename, or a string, unless you've already # specified a template with load() function run($templ = false) { + $template_string = $this->template; + $template_file = $this->file; if($templ !== false) { if(strlen($templ) < 150 && file_exists($templ)) { - $this->filename = $templ; - unset($this->template); + $template_file = $templ; + unset($template_string); } else { - $this->template = $templ; + $template_string = $templ; } } - if(!$this->template) { - if(!$this->filename) { + if(!$template_string) { + if(!$template_file) { print "sorry, no template to run\n"; exit(1); } - $this->template = read_whole_file($this->filename); + $template_string = read_whole_file($template_file); } - return template_run($this->template, $this->keyval); + return template_run($template_string, $this->keyval); } # same as run() except the output is print()ed function output($templ = false) { print($this->run($templ)); } + + # return the contents of the top-level sub-templates + # + # this does not run the sub-templates, so if you've not called tem_sub() on them, they will be blank. + # + # Return a hash. + # keys: name of top level sub-template. + # values: contents of said sub-template. + function top_subs() { + $ret = array(); + if(isset($this->sub_subs['top_level_subs'])) { + foreach($this->sub_subs['top_level_subs'] as $name) { + $ret[$name] = $this->get($name); + } + } + return $ret; + } } # Below are functions so you can use the above class without allocating or @@ -184,27 +237,20 @@ function tem_output($filename = false) { -function read_whole_file($name) { - $fd = fopen($name, 'r'); - if($fd === false) { - die("Failed to read file: '$name'"); - } - $temp = fread($fd, filesize($name)); - fclose($fd); - return $temp; -} - # this is used in template_run() and should be of no other use function template_filler($matches) { list($tag, $enc) = explode('.', $matches[1], 2); $value = $GLOBALS['wfpl_template_keyval'][$tag]; if($enc) { - $enc = "enc_$enc"; - if(function_exists($enc)) { - $value = $enc($value); - } else { - print "ERROR: encoder function '$enc' not found.
\n"; - exit(1); + $encs = explode('.', $enc); + foreach($encs as $enc) { + $enc = "enc_$enc"; + if(function_exists($enc)) { + $value = $enc($value, $tag); + } else { + print "ERROR: encoder function '$enc' not found.
\n"; + exit(1); + } } } return $value; @@ -218,5 +264,9 @@ function template_run($template, &$keyval) { return preg_replace_callback(array('||', '|~([^~]*)~|', '|([^<]*)|', '|

([^<]*)

|'), 'template_filler', $template); } +function tem_top_subs() { + tem_init(); + return $GLOBALS['wfpl_template']->top_subs(); +} ?>