X-Git-Url: https://jasonwoof.com/gitweb/?a=blobdiff_plain;f=template.php;h=03f11ea8635c4f3583809a1e04f80a9f8488c2f5;hb=2afca1009c633e58731dab771e80ad722c399dff;hp=e386fe2ed6e7b52db94ab9eef12552202f7fe467;hpb=0829623c0e10d5cc83e12547387b5fa0abaf43e0;p=wfpl.git
diff --git a/template.php b/template.php
index e386fe2..03f11ea 100644
--- a/template.php
+++ b/template.php
@@ -1,268 +1,307 @@
#
-# This file is part of wfpl.
+# This program 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 3 of the License, or
+# (at your option) any later version.
+#
+# This program 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.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see .
+
+
+# This is a simple template-handling system. You pass it a big data
+# structure with key/value pairs, and a template string to fill out.
#
-# 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.
+# Within a template, it recognizes tags of the form ~name [arg...]~,
+# optionally wrapped in HTML comments (which will be removed along with
+# the tag markers when the template is filled out).
#
-# 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.
+# { and } as the final argument mark those tags as being the start and
+# end of a sub-template (for optional or repeated sections). All other
+# tags represent slots to be directly filled by data values. On a }
+# tag, the name is optional, but must match the corresponding { tag if
+# present.
#
-# 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
-
+# For a value tag, arguments represent encodings to be applied
+# successively. For instance, ~foo html~ will encode it to be safe in
+# HTML ('&' to '&', '<' to '<', and so on).
+#
+# { tags can take one argument, which will call the corresponding
+# tem_auto_* function to munge the data, automating certain common use
+# cases. See the comments on the tem_auto functions for more details.
-# This file contains generally useful template handling code. It is wrapped in
-# an object so that if you want/need to you can make more than one instance of
-# it and they won't step on each other's toes. Also there are a set of global
-# functions at the bottom so you don't have to mess around with objects if you
-# don't want to. The documentation will be on the object methods, but just know
-# that each has a straight function wrapper at the bottom with 'tem_' prepended
-# to the name.
+require_once('code/wfpl/encode.php');
+require_once('code/wfpl/file.php');
+require_once('code/wfpl/misc.php');
-# This is designed to be as simple as it can be for your project. The simple
-# way to use it is to set some key/value pairs with tem_set() then call
-# 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
+# Top-Level Functions
+# -------------------
-require_once('code/wfpl/encode.php');
-require_once('code/wfpl/misc.php');
-require_once('code/wfpl/file.php');
+function template($template, $data) {
+ return fill_template(parse_template($template), $data);
+}
-class tem {
- var $keyval; # an array containing key/value pairs
- 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('' => '~'); # so that ~~ in the template creates a single ~
- $this->sub_templates = array();
- }
+function template_file($filename, $data) {
+ return fill_template(parse_template_file($filename), $data);
+}
- # set a key/value pair. if a ~tag~ in the template matches key it will be replaced by value
- function set($key, $value) {
- $this->keyval[$key] = $value;
- }
+function parse_template_file($filename) {
+ return parse_template(file_get_contents($filename));
+}
- # clear a value. Functionally equivalent to set($key, '') but cleaner and more efficient
- function clear($key) {
- unset($this->keyval[$key]);
- }
+# See also parse_template and fill_template.
- # grab a value you stuck in earlier with set()
- function get($key) {
- return $this->keyval[$key];
- }
- # run the template engine on one of the sub-templates and append the result
- # to the keyval in the main array. See tem_test.php for an example of how
- # this can be used.
- function sub($sub_template_name) {
- $this->keyval[$sub_template_name] .= template_run($this->sub_templates[$sub_template_name], $this->keyval);
+# To track our position in the template and in the data, we use a linked
+# stack structure. Each node is a hash with a reference to the parent
+# node along with whatever other data you want to add. For each stack,
+# you simply keep a variable with a reference to the top element. Then
+# the push and pop operations are:
- # 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);
- }
- }
- }
+# $top =& tem_push($top);
+# $top =& $top['parent'];
- # this is used by tem::load() and should be otherwise useless
- 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;
- }
+ $refs[] = array();
+ $new =& $refs[count($refs)-1];
+ if($stack) $new['parent'] =& $stack;
+ return $new;
+}
- $matches = array();
- # this limits sub_template names to 50 chars
- 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();
+# First we take the template string and convert it into a tree of
+# strings and sub-templates. A template is a hash with a name string,
+# a pieces array, and possibly an args array.
+
+function parse_template($string) {
+ $tem =& tem_push();
+ $tem['pieces'] = array();
+ # note: for some reason this captures ''.
+ $matches = preg_split("/()/", $string, -1, PREG_SPLIT_DELIM_CAPTURE);
+ foreach($matches as $match) {
+ if(substr($match,0,1) == '~') {
+ $args = explode(' ', substr($match,1,-1));
+
+ if(count($args) == 1 and $args[0] == '}') $name = '';
+ else $name = array_shift($args);
+
+ if(last($args) == '{') { # open block
+ array_pop($args);
+ # create a new sub-template
+ # and add it to the parent.
+ $tem =& tem_push($tem);
+ $tem['parent']['pieces'][] =& $tem;
+ $tem['name'] = $name;
+ $tem['pieces'] = array();
+ $tem['args'] = $args;
+ } elseif(last($args) == '}') { # close block
+ array_pop($args);
+ $cur = $tem['name'];
+ if($name && $name != $cur) {
+ die("Invalid template: tried to close '$name', but '$cur' is current.");
}
- 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], $parents, $parent);
- } else {
- # it's not a start tag or end tag, so let's pass it through:
- $out .= substr($in, 0, 5);
- $in = substr($in, 5);
+ $tem =& $tem['parent'];
+ } else { # value slot
+ $tem['pieces'][] = array('name' => $name, 'args' => $args);
}
- } #repeat
+ } elseif($match and $match != '|', '|~([^~]*)~|', '|([^<]*)|', '|
([^<]*)
|'), 'template_filler', $template);
+
+# tem_auto functions
+# ------------------
+#
+# If a { tag has an argument, the corresponding tem_auto function is called.
+# This allows it to mangle the data to automate some common cases.
+
+# 'sep' (separator) sections will be shown for all but the last parent row.
+# Sample usage:
+#
+#
+# row content...
+#
+#
+#
+#
+function tem_auto_sep($key, $context) {
+ $rows =& $context['parent']['rows'];
+ if(key($rows)) return true;
+ # else we are on the last row (cursor has hit the end and reset).
}
-function tem_top_subs() {
- tem_init();
- return $GLOBALS['wfpl_template']->top_subs();
+# 'once' sections will be shown once unless the corresponding data value
+# is false. We check only for false; 0 or '' will not work.
+
+function tem_auto_once($key, $context) {
+ if($context['data'][$key] !== false)
+ return tem_data_as_rows(true);
+}
+
+# 'evenodd' sections are given an 'evenodd' attribute whose value
+# alternates between 'even' and 'odd'.
+
+function tem_auto_evenodd($key, $context) {
+ $rows = $context['data'][$key];
+ $even = 0;
+ $text = array('even', 'odd');
+ foreach($rows as $key => $value) {
+ $rows[$key]['evenodd'] = $text[$even];
+ $even = 1 - $even;
+ }
+ return tem_data_as_rows($rows);
}
?>