X-Git-Url: https://jasonwoof.com/gitweb/?a=blobdiff_plain;f=template.php;h=fc7302b2ec81edb5ea6ff159f64e9e119cb7c1ac;hb=6a88a3451b48633071536c74a6b654e84ac064f6;hp=9ccce8708e5eb991175eb22ce783d08ce408d148;hpb=ba50d9a564ca3b8637212c634b5a61a38e6feb9f;p=wfpl.git
diff --git a/template.php b/template.php
index 9ccce87..fc7302b 100644
--- a/template.php
+++ b/template.php
@@ -19,113 +19,269 @@
# 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.
#
-# Within a template, it recognizes tags delimited by tildes (~). When
-# the template is filled out, the tags will be replaced with the
-# corresponding data. Tags ending with '?' and '.' mark the start and
-# end of a sub-template (for optional or repeated text), and can be
-# wrapped in HTML comments (which will be removed along with the tags
-# when the template is filled out).
+# 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).
+#
+# { 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.
+#
+# 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.
require_once('code/wfpl/encode.php');
require_once('code/wfpl/file.php');
require_once('code/wfpl/misc.php');
-# Public functions
-# ----------------
+# Top-Level Functions
+# -------------------
-function template($data, $template) {
- return fill_template($data, parse_template($template));
+function template($template, $data) {
+ return fill_template(parse_template($template), $data);
}
-function template_file($data, $filename) {
- return fill_template($data, parse_template_file($filename));
+function template_file($filename, $data) {
+ return fill_template(parse_template_file($filename), $data);
}
-function parse_template_file($filename) {
+function &parse_template_file($filename) {
return parse_template(file_get_contents($filename));
}
-# First we take the template string and break it up into an array
-# of strings and sub-arrays. The first item in a sub-array is the name
-# of the value or sub-template.
+# We parse the template string 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) {
- # Don't mess with the $stack/$tem assignments! Since
- # PHP references point to the variable, not the data,
- # it really does have to be written exactly like this.
- $stack[] = array('name' => 'root', 'pieces' => array());
- $tem = &last($stack);
- # note: for some reason this captures ''.
- $matches = preg_split("/()/", $string, -1, PREG_SPLIT_DELIM_CAPTURE);
+function &parse_template($string) {
+ $tem =& tem_push();
+ $tem['pieces'] = array();
+ $matches = preg_split('/()/', preg_replace('//', '$1', $string), -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
foreach($matches as $match) {
- if(substr($match,0,1) == '~') {
+ if($match == '~~') $match = '~';
+ if(substr($match,0,1) == '~' and strlen($match) > 2) {
$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);
- $stack[] = array('name' => $name, 'pieces' => array(), 'args' => $args);
- $tem['pieces'][] = &last($stack);
- $tem = &last($stack);
+ array_pop($args); # drop '{'
+ $tem =& tem_push($tem); # create a new sub-template
+ $tem['parent']['pieces'][] =& $tem; # as a piece of the parent
+ $tem['name'] = $name;
+ $tem['pieces'] = array();
+ $tem['args'] = $args;
} elseif(last($args) == '}') { # close block
- array_pop($args);
- $cur = $stack[count($stack)-1]['name'];
+ array_pop($args); # drop '}'
+ $cur = $tem['name'];
if($name && $name != $cur) {
- die("Invalid template: tried to close '$name', but '$cur' is current.");
+ die("Invalid template: tried to close '$name', but '$cur' is current.");
}
- array_pop($stack); $tem = &last($stack);
+ $tem =& $tem['parent'];
} else { # value slot
$tem['pieces'][] = array('name' => $name, 'args' => $args);
}
- } elseif($match and $match != '
-#
+#
+#
# row content...
-#
-#
-#
+#
+#
+#
#
-function tem_auto_sep($piece, $context, $keychain) {
- list($name, $index, $this_name) = array_slice($keychain, -3);
- $array = _tem_get($name, $context);
- if($index != count($array)-1) return true;
+function tem_auto_sep(&$value, $key, $context) {
+ $rows =& $context['parent']['parent'];
+ if($rows['cur'] != count($rows['rows'])-1) # last row?
+ return true; # show once
+}
+
+# auto-show once, only when this is the first row of the parent
+function tem_auto_last(&$value, $key, $context) {
+ $rows =& $context['parent']['parent'];
+ if($rows['cur'] == count($rows['rows'])-1) # last row?
+ return true; # show once
+}
+
+# auto-show once, only when this is the last row of the parent
+function tem_auto_first(&$value, $key, $context) {
+ $rows =& $context['parent']['parent'];
+ if($rows['cur'] == 0) # first row?
+ return true; # show once
}
-# 'once' sections will be shown once unless the corresponding data value
-# is false. We check only for false; 0 or '' will not work.
+# 'show' sections will be shown unless the corresponding data
+# value === false
+function tem_auto_show(&$value) {
+ if($value === null) return true;
+ return $value;
+}
+
+# 'empty' sections will be shown only if the corresponding data value is the
+# empty string
+function tem_auto_empty(&$value) {
+ if($value === '') return true;
+ return null;
+}
+
+# 'nonempty' sections will not be shown if the corresponding data
+# value is the empty string
+function tem_auto_nonempty(&$value) {
+ if($value === '') return null;
+ return $value;
+}
-function tem_auto_once($piece, $context, $keychain) {
- $value = _tem_get(array_pop($keychain), $context);
- if($value !== false) return true;
+# 'unset' sections will not be shown if the corresponding data
+# value is not set (opposite of default)
+function tem_auto_unset(&$value) {
+ if($value === null) {
+ return '';
+ } else {
+ return null;
+ }
}
# 'evenodd' sections are given an 'evenodd' attribute whose value
# alternates between 'even' and 'odd'.
-
-function tem_auto_evenodd($piece, $context, $keychain) {
- $rows = _tem_get(array_pop($keychain), $context);
- $even = 0;
- $text = array('even', 'odd');
- foreach($rows as $key => $value) {
- $rows[$key]['evenodd'] = $text[$even];
- $even = 1 - $even;
+function tem_auto_evenodd(&$values) {
+ $even = true;
+ if($values) foreach($values as &$value) {
+ $value['evenodd'] = $even ? 'even' : 'odd';
+ $even = !$even;
}
- return $rows;
+ return $values;
}
+# 'once' sections are shown exactly once if the value is set (and not at all
+# otherwise.) This is useful when an array value would otherwise cause the
+# section to be displayed multiple times.
+function tem_auto_once(&$value) {
+ if($value === null) return null;
+ return true;
+}
+function tem_auto_once_if(&$value) {
+ if($value) return true;
+ return null;
+}
-# Internal functions
-# ------------------
-#
-# Of course, nothing stops you from using these, but I don't know
-# why you would want to...
+# 'once' sections are shown exactly once if php evaluates the value to false
+# (and not at all otherwise.) This is useful when an array value would
+# otherwise cause the section to be displayed multiple times.
+function tem_auto_once_else(&$value) {
+ if($value) return null;
+ return true;;
+}
-# Convert value to array of hashes for use in sub-template expansion.
-# This adds flexibility to how you represent your data.
-function template_rows($value) {
- if(is_array($value)) {
- # numeric keys, is already array of arrays -- expand sub-template for each.
- if(array_key_exists(0, $value)) return $value;
- # key/value pairs -- expand sub-template once.
- else return array($value);
- } elseif($value) {
- # value -- expand sub-template once using only parent values
- return array(array());
- } else {
- # empty value -- don't expand sub-template
- return array();
- }
+
+
+
+# Backward Compatibility
+# ----------------------
+
+function is_shown($piece) {
+ return $piece['args'][0] == 'hide';
}
-function _tem_get($key, $context) {
- while($context) {
- $data = array_pop($context);
- if(array_key_exists($key, $data)) return $data[$key];
- }
+function is_shown_sub_template($piece) {
+ return is_sub_template($piece) and is_shown($piece);
}
-function tem_get($piece, $context, $keychain)
-{
- if(count($piece['args'])) {
- $func = "tem_auto_" . $piece['args'][0];
- if(function_exists($func)) return $func($piece, $context, $keychain);
- else die("ERROR: template auto function '$func' not found.
\n");
- } else return _tem_get($piece['name'], $context);
+# Old-style templates don't show unless explicitly requested.
+function tem_auto_hide(&$value, $key, $context) {
+ unset($context['data'][$key]);
+ return false;
}
-# $tag is a hash with keys 'name' and 'args'.
-function tem_get_enc($tag, $context)
-{
- $key = $tag['name'];
- $value = _tem_get($key, $context);
- foreach($tag['args'] as $encoding) {
- $func = "enc_$encoding";
- if(function_exists($func)) $value = $func($value, $key);
- else die("ERROR: encoder function '$func' not found.
\n");
+# The old API is being used with the named sub-template,
+# so hide it and insert a value slot for its expansion(s).
+function &tem_is_old_sub($name, &$template) {
+ foreach($template['pieces'] as $key => &$piece) {
+ if(is_sub_template($piece)) {
+ if($piece['name'] == $name) {
+ if(!is_shown($piece)) {
+ # hide template unless explicitly show()n.
+ $piece['args'] = array('hide');
+ # insert a value slot with the same name (for the expansion).
+ $var = array('name' => $name, 'args' => array());
+ array_splice($template['pieces'], $key, 0, array($var));
+ }
+ return $piece;
+ }
+ $tem = tem_is_old_sub($name, $piece);
+ if($tem) return $tem;
+ }
}
- return $value;
+ return false;
}
-function top_sub_templates($tem) {
- $subs = array();
- foreach($tem['pieces'] as $piece) {
- if(is_array($piece) and $piece['pieces']) {
- $subs[$piece['name']] = $piece;
+class tem {
+ var $template;
+ var $data;
+
+ function tem() {
+ $this->template = array('pieces' => array());
+ $this->data = array();
+ }
+
+ function set($key, $value = true) {
+ $this->data[$key] = $value;
+ }
+
+ function sets($hash) {
+ foreach($hash as $key => $value) {
+ $this->set($key, $value);
}
}
- return $subs;
+
+ function append($key, $value) {
+ $this->data[$key] .= $value;
+ }
+
+ function prepend($key, $value) {
+ $this->data[$key] = $value . $this->data[$key];
+ }
+
+ function clear($key) {
+ unset($this->data[$key]);
+ }
+
+ function get($key) {
+ return $this->data[$key];
+ }
+
+ function show($name) {
+ $tem = tem_is_old_sub($name, $this->template);
+ if($tem) {
+ $this->data[$name] .= fill_template($tem, $this->data);
+ }
+ }
+
+ function show_separated($name) {
+ if($this->get($name)) {
+ $this->show($name . '_sep');
+ }
+ $this->show($name);
+ }
+
+ function load_str($str) {
+ $this->template =& parse_template($str);
+ }
+
+ function load($filename) {
+ $this->template =& parse_template_file($filename);
+ }
+
+ function run($tem = false) {
+ if($tem) {
+ if(strlen($tem < 150 && file_exists($tem))) $this->load($tem);
+ else $this->load_str($tem);
+ }
+
+ return fill_template($this->template, $this->data);
+ }
+
+ function output($tem = false) {
+ print($this->run($tem));
+ }
+
+ # merge top-level sub-templates of $tem (object) into $this,
+ # supporting both new and old semantics.
+ function merge($tem) {
+ # append expansions to $this->data (old style)
+
+ $subs = $tem->top_subs('is_shown_sub_template');
+ if($subs) foreach($subs as $name => $val) {
+ $this->append($name, $val);
+ unset($tem->data[$name]); # so array_merge() won't overwrite things
+ }
+
+ # merge the data arrays and template trees (new style)
+ $this->data = array_merge($this->data, $tem->data);
+ merge_templates($this->template, $tem->template);
+ }
+
+ # see merge() above
+ function merge_file($filename) {
+ $other_tem = new tem();
+ $other_tem->load($filename);
+ $this->merge($other_tem);
+ }
+
+ function top_sub_names($is_sub = 'is_sub_template') {
+ return array_keys(top_sub_templates($this->template, $is_sub));
+ }
+
+ function top_subs($is_sub = 'is_sub_template') {
+ $ret = array();
+ $names = $this->top_sub_names($is_sub);
+ foreach($names as $name) {
+ $ret[$name] = $this->get($name);
+ }
+ return $ret;
+ }
+
+ # old name for show (deprecated)
+ function sub($name) {
+ $this->show($name);
+ }
+}
+
+function tem_init() {
+ if(!$GLOBALS['wfpl_template']) {
+ $GLOBALS['wfpl_template'] = new tem();
+ }
+}
+
+function tem_append($key, $value) {
+ tem_init();
+ $GLOBALS['wfpl_template']->append($key, $value);
+}
+
+function tem_prepend($key, $value) {
+ tem_init();
+ $GLOBALS['wfpl_template']->prepend($key, $value);
+}
+
+function tem_set($key, $value = true) {
+ tem_init();
+ $GLOBALS['wfpl_template']->set($key, $value);
+}
+
+function tem_sets($hash) {
+ tem_init();
+ $GLOBALS['wfpl_template']->sets($hash);
+}
+
+function tem_get($key) {
+ tem_init();
+ return $GLOBALS['wfpl_template']->get($key);
+}
+
+function tem_run($tem = false) {
+ tem_init();
+ return $GLOBALS['wfpl_template']->run($tem);
+}
+
+function tem_show($name) {
+ tem_init();
+ return $GLOBALS['wfpl_template']->show($name);
+}
+
+function tem_show_separated($name) {
+ tem_init();
+ $GLOBALS['wfpl_template']->show_separated($name);
+}
+
+function tem_load($filename) {
+ tem_init();
+ $GLOBALS['wfpl_template']->load($filename);
+}
+
+function tem_merge($tem) {
+ tem_init();
+ $GLOBALS['wfpl_template']->merge($tem);
+}
+
+function tem_merge_file($filename) {
+ tem_init();
+ $GLOBALS['wfpl_template']->merge_file($filename);
+}
+
+function tem_output($filename = false) {
+ tem_init();
+ $GLOBALS['wfpl_template']->output($filename);
+}
+
+function tem_top_subs() {
+ tem_init();
+ return $GLOBALS['wfpl_template']->top_subs();
+}
+
+function tem_top_sub_names() {
+ tem_init();
+ return $GLOBALS['wfpl_template']->top_sub_names();
+}
+
+function tem_load_new($filename) {
+ $old = $GLOBALS['wfpl_template'];
+ $GLOBALS['wfpl_template'] = new tem();
+ $GLOBALS['wfpl_template']->load($filename);
+ return $old;
+}
+
+# deprecated (old name for show)
+function tem_sub($name) {
+ tem_show($name);
}
?>