X-Git-Url: https://jasonwoof.com/gitweb/?a=blobdiff_plain;f=template.php;h=1667cdead3e1c59287a0f422311b3c5b748e406e;hb=dfd0f158f89020b3142e41127d21e48c8512aa1e;hp=da05621d229d8befb96caaf6f625d7ed30d44a9a;hpb=ab02f499da7918c55edc4d17c88ec7a39ea887b8;p=wfpl.git
diff --git a/template.php b/template.php
index da05621..1667cde 100644
--- a/template.php
+++ b/template.php
@@ -42,52 +42,52 @@ 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) {
return parse_template(file_get_contents($filename));
}
-# 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.
+# 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);
+ $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) == '~') {
+ 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.");
}
- array_pop($stack); $tem = &last($stack);
+ $tem =& $tem['parent'];
} else { # value slot
$tem['pieces'][] = array('name' => $name, 'args' => $args);
}
@@ -98,32 +98,158 @@ function parse_template($string) {
return $tem;
}
-# Then we do a depth-first traversal of the template tree,
-# replacing all tags with the data values.
-
-function fill_template($data, $template, $context = NULL, $keychain = NULL) {
- $context[] = $data;
- foreach($template['pieces'] as $piece) {
- if(is_string($piece)) $output .= $piece;
- else {
- if($piece['pieces']) { # sub-template
- $keychain[] = $piece['name'];
- $rows = tem_get_rows($piece, $context, $keychain);
- foreach($rows as $key => $row) {
- $keychain[] = $key;
- $output .= fill_template($row, $piece, $context, $keychain);
- array_pop($keychain);
- }
- array_pop($keychain);
- } else { # variable
- $output .= tem_get_enc($piece, $context);
+function fill_template($template, &$data, &$context = NULL) {
+ $context =& tem_push($context);
+ $context['data'] =& $data;
+
+ foreach($template['pieces'] as $tem) {
+ if(is_string($tem)) $output .= $tem;
+ elseif($tem['pieces']) { # sub-template
+ $rows =& tem_row_data($tem, $context);
+ $context['rows'] =& $rows;
+ foreach($rows as $key => &$row) {
+ $context['cur'] = $key;
+ $output .= fill_template($tem, $row, $context);
}
+ } else { # variable
+ $output .= tem_encoded_data($tem, $context);
}
}
+ $context =& $context['parent'];
return $output;
}
+# Implementation
+# --------------
+
+
+# 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:
+
+# $top =& tem_push($top);
+# $top =& $top['parent'];
+
+function &tem_push(&$stack = NULL) {
+ static $refs = array();
+
+ # Since a PHP reference is *not* a pointer to data, but a pointer to
+ # a variable (or array slot), we *have* to first put the new node in
+ # $refs, and then reference it from $new.
+
+ $refs[] = array();
+ $new =& $refs[count($refs)-1];
+ if($stack) $new['parent'] =& $stack;
+ return $new;
+}
+
+# To fill out a template, we do a depth-first traversal of the template
+# tree, replacing all tags with the data values.
+
+# The data starts out as a nested set of key/value pairs, where the
+# values can be:
+
+ # a string to fill a value slot
+ # a hash to fill one instance of a sub-template
+ # an array of hashes to fill multiple instances of a sub-template
+
+# The middle form will be converted to the last form as we use it.
+
+function tem_data_as_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();
+ }
+}
+
+# To look up a key, we check each namespace (starting with the
+# innermost one) until a value is found.
+
+function tem_data_scope($key, $context) {
+ static $refs = array();
+
+ $scope = $context;
+ do{
+ if(array_key_exists($key, $scope['data'])) {
+ return $scope;
+ }
+ } while($scope = $scope['parent']);
+
+ # not found; return empty scope.
+ $refs[] = array();
+ $ret = array();
+ $ret['parent'] =& $context;
+ $ret['data'] =& last($refs);
+ return $ret;
+}
+
+function tem_get_data($key, $context) {
+ $scope = tem_data_scope($key, $context);
+ if($scope) return $scope['data'][$key];
+}
+
+# Return the value for a tag as a set of rows to fill a sub-template.
+# If $tag has an arg, call the tem_auto function to munge the data.
+function &tem_row_data($tem, $context)
+{
+ $key = $tem['name'];
+ $scope = tem_data_scope($key, $context);
+
+ if(count($tem['args'])) {
+ $auto_func = "tem_auto_" . $tem['args'][0];
+ function_exists($auto_func)
+ or die("ERROR: template auto function '$auto_func' not found.
\n");
+ }
+ if($auto_func) $value = $auto_func($scope['data'][$key], $key, $scope);
+ else $value = $scope['data'][$key];
+
+ $rows = tem_data_as_rows($value);
+ if(is_array($value)) $scope['data'][$key] = $rows;
+
+ return $rows;
+}
+
+# Return the value for a tag as an encoded string.
+function tem_encoded_data($tag, $context)
+{
+ $key = $tag['name'];
+ $value = tem_get_data($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");
+ }
+ return $value;
+}
+
+
+function is_sub_template($piece) {
+ return is_array($piece) and $piece['pieces'];
+}
+
+# Return a hash containing the top-level sub-templates of tem.
+function top_sub_templates($tem, $is_sub = 'is_sub_template') {
+ function_exists($is_sub) or die("no such function '$is_sub'.");
+ $subs = array();
+ foreach($tem['pieces'] as $piece) {
+ if($is_sub($piece)) {
+ $subs[$piece['name']] = $piece;
+ }
+ }
+ return $subs;
+}
+
# Replace top-level values in $main with top-level templates from $tem.
function merge_templates($main, $tem) {
$out = array('name' => $main['name'], 'pieces' => array());
@@ -131,7 +257,8 @@ function merge_templates($main, $tem) {
$subs = top_sub_templates($tem);
foreach($main['pieces'] as $piece) {
- if(is_array($piece) and !$piece['pieces'] and $subs[$piece['name']]) {
+ $sub = $subs[$piece['name']];
+ if(is_array($piece) and !$piece['pieces'] and $sub and $sub['args'][0] != 'hide') {
$piece = $subs[$piece['name']];
}
$out['pieces'][] = $piece;
@@ -149,109 +276,252 @@ function merge_templates($main, $tem) {
# 'sep' (separator) sections will be shown for all but the last parent row.
# Sample usage:
-#
-#
+#
+#
# 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 $value = true; # show once
}
-# 'once' sections will be shown once unless the corresponding data value
+# 'show' sections will be shown unless the corresponding data value
# is false. We check only for false; 0 or '' will not work.
-function tem_auto_once($piece, $context, $keychain) {
- $value = tem_get(array_pop($keychain), $context);
- if($value !== false) return true;
+function tem_auto_show(&$value) {
+ if($value !== false) $value = array(array());
+ return $value;
}
# '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 = false;
+ foreach($values as &$value) {
+ $value['evenodd'] = $even ? 'even' : 'odd';
+ $even = !$even;
}
- return $rows;
+ return $values;
}
-# Internal functions
-# ------------------
-#
-# Of course, nothing stops you from using these, but I don't know
-# why you would want to...
-# Convert value to array of hashes for use in sub-template expansion.
-# This adds flexibility to how you represent your data.
-function tem_value_as_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
+# ----------------------
-# Search the current context and return the value for key.
-function tem_get($key, $context) {
- while($context) {
- $data = array_pop($context);
- if(array_key_exists($key, $data)) return $data[$key];
- }
+function is_shown($piece) {
+ return $piece['args'][0] == 'hide';
}
-# Return the value for a tag as a set of rows to fill a sub-template.
-# If $tag has an arg, call the tem_auto function to munge the data.
-function tem_get_rows($tag, $context, $keychain)
-{
- if(count($tag['args'])) {
- $func = "tem_auto_" . $tag['args'][0];
- if(function_exists($func)) $value = $func($tag, $context, $keychain);
- else die("ERROR: template auto function '$func' not found.
\n");
- } else $value = tem_get($tag['name'], $context);
+function is_shown_sub_template($piece) {
+ return is_sub_template($piece) and is_shown($piece);
+}
- return tem_value_as_rows($value);
+# Old-style templates don't show unless explicitly requested.
+function tem_auto_hide(&$value, $key, $context) {
+ unset($context['data'][$key]);
+ return false;
}
-# Return the value for a tag as an encoded string.
-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) {
+ $this->data[$key] = $value;
+ }
+
+ 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);
}
}
- return $subs;
+
+ 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);
+ $this->template = merge_templates($this->template, $tem->template);
+ }
+
+ 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) {
+ tem_init();
+ $GLOBALS['wfpl_template']->set($key, $value);
+}
+
+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_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);
}
?>