<?php
-# Copyright (C) 2008,2009 Joshua Grams <josh@qualdan.com>
-#
-# 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 <http://www.gnu.org/licenses/>.
+# This program is in the public domain within the United States. Additionally,
+# we waive copyright and related rights in the work worldwide through the CC0
+# 1.0 Universal public domain dedication, which can be found at
+# http://creativecommons.org/publicdomain/zero/1.0/
# This is a simple template-handling system. You pass it a big data
# 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');
+require_once(__DIR__.'/'.'encode.php');
+require_once(__DIR__.'/'.'file.php');
+require_once(__DIR__.'/'.'misc.php');
# Top-Level Functions
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));
}
-# We parse the template string into a tree of strings and sub-templates.
+# 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) {
+function &parse_template($string) {
$tem =& tem_push();
$tem['pieces'] = array();
- # note: for some reason this captures '<!--' but not '-->'.
- $matches = preg_split("/(<!--)?(~[^~]*~)(?(1)-->)/", $string, -1, PREG_SPLIT_DELIM_CAPTURE);
+ $matches = preg_split('/(<!--)?(~[^~]*~)(?(1)-->)/', preg_replace('/<!--(~[^~]*~)-->/', '$1', $string), -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
foreach($matches as $match) {
if($match == '~~') $match = '~';
if(substr($match,0,1) == '~' and strlen($match) > 2) {
if(count($args) == 1 and $args[0] == '}') $name = '';
else $name = array_shift($args);
- if(last($args) == '{') { # open block
+ if(count($args) && $args[count($args)-1] == '{') { # open block
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
+ } elseif(count($args) && $args[count($args)-1] == '}') { # close block
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.");
}
$tem =& $tem['parent'];
} else { # value slot
$tem['pieces'][] = array('name' => $name, 'args' => $args);
}
- } elseif($match and $match != '<!--') { # static string
+ } else { # static string
$tem['pieces'][] = $match;
}
}
function fill_template($template, &$data, &$context = NULL) {
$context =& tem_push($context);
$context['data'] =& $data;
+ $output = '';
foreach($template['pieces'] as $tem) {
if(is_string($tem)) $output .= $tem;
- elseif($tem['pieces']) { # sub-template
+ elseif(isset($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);
+ $output .= tem_apply_encodings($tem['name'], fill_template($tem, $row, $context), $tem['args']);
}
} else { # variable
$output .= tem_encoded_data($tem, $context);
# The middle form will be converted to the last form as we use it.
-function tem_data_as_rows($value) {
+function tem_data_as_rows($value, $key) {
if(is_array($value)) {
- # numeric keys, is already array of arrays -- expand sub-template for each.
- if(array_key_exists(0, $value)) return $value;
+ # numeric keys
+ if(array_key_exists(0, $value)) {
+ if(is_array($value[0])) return $value; # already array of hashes.
+ else return columnize($value, $key);
# key/value pairs -- expand sub-template once.
- else return array($value);
- } elseif($value) {
+ } else return array($value);
+ } elseif($value || $value === 0 || $value === '0' || $value === '') {
# value -- expand sub-template once using only parent values
return array(array());
} else {
if(array_key_exists($key, $scope['data'])) {
return $scope;
}
- } while($scope = $scope['parent']);
+ } while($scope = isset($scope['parent']) ? $scope['parent'] : null);
# not found; return empty scope.
$refs[] = array();
$ret = array();
$ret['parent'] =& $context;
- $ret['data'] =& last($refs);
+ $ret['data'] =& $refs[count($refs) - 1];
return $ret;
}
function tem_get_data($key, $context) {
$scope = tem_data_scope($key, $context);
- if($scope) return $scope['data'][$key];
+ if($scope) return isset($scope['data'][$key]) ? $scope['data'][$key] : null;
}
# Return the value for a tag as a set of rows to fill a sub-template.
{
$key = $tem['name'];
$scope = tem_data_scope($key, $context);
+ $auto_func = false;
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.<br>\n");
+ if (!function_exists($auto_func)) {
+ if (function_exists("enc_" . $tem['args'][0])) {
+ $auto_func = false;
+ } else {
+ die("ERROR: template auto function '$auto_func' not found.<br>\n");
+ }
+ }
+ # NAMESPACIFY $auto_func
+ }
+ $value = isset($scope['data'][$key]) ? $scope['data'][$key] : null;
+ if ($auto_func) {
+ $value = $auto_func($value, $key, $scope, $tem['args']);
}
- 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;
+ $rows = tem_data_as_rows($value, $key);
+ if(is_array($value)) {
+ $scope['data'][$key] = $rows;
+ }
return $rows;
}
+function tem_apply_encodings ($key, $value, $encodings) {
+ if ($encodings) foreach($encodings as $encoding) {
+ $func = "enc_$encoding";
+ if (function_exists($func)) {
+ # NAMESPACIFY $func
+ $value = $func($value, $key);
+ } elseif (!function_exists("tem_auto_$encoding")) {
+ die("ERROR: encoder function '$func' not found.<br>\n");
+ }
+ }
+ return $value;
+}
+
# 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.<br>\n");
- }
- return $value;
+ return tem_apply_encodings($key, $value, $tag['args']);
}
+function is_sub_template(&$piece) {
+ return is_array($piece) && isset($piece['pieces']);
+}
+
+function is_value_slot(&$piece) {
+ return is_array($piece) && !isset($piece['pieces']);
+}
# Return a hash containing the top-level sub-templates of tem.
-function top_sub_templates($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_array($piece) and $piece['pieces']) {
- $subs[$piece['name']] = $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());
+# merge $subs (sub_templates) into variables in $main (template)
+function merge_sub_templates(&$main, &$subs) {
+ foreach($main['pieces'] as &$piece) {
+ if(is_array($piece)) { # not just text
+ if(isset($piece['pieces']) && $piece['pieces']) {
+ # a sub-template in main
+ merge_sub_templates($piece, $subs);
+ } else {
+ # a value-slot in main
+ $sub = isset($subs[$piece['name']]) ? $subs[$piece['name']] : null;
+ $arg0 = isset($sub['args'][0]) ? $sub['args'][0] : null;
+ if($sub && $arg0 != 'hide') {
+ $piece = $subs[$piece['name']];
+ $piece['parent'] =& $main;
+ }
+ }
+ }
+ }
+}
+# Replace values in $main with top-level templates from $tem.
+function merge_templates(&$main, &$tem) {
$subs = top_sub_templates($tem);
- foreach($main['pieces'] as $piece) {
- $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;
- }
- return $out;
+ merge_sub_templates($main, $subs);
}
# <!--~rows {~-->
# <!--~row {~-->
# row content...
-# <!--~separator sep {~--><hr><!--~}"-->
+# <!--~separator sep {~--><hr><!--~}~-->
# <!--~}~-->
# <!--~}~-->
#
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
+ 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
}
-# 'show' sections will be shown unless the corresponding data value
-# is false. We check only for false; 0 or '' will not work.
+# 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
+}
+# 'show' sections will be shown unless the corresponding data
+# value === false
function tem_auto_show(&$value) {
- if($value !== false) $value = array(array());
+ 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;
+}
+
+# '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(&$values) {
- $even = false;
- foreach($values as &$value) {
+ $even = true;
+ if($values) foreach($values as &$value) {
$value['evenodd'] = $even ? 'even' : 'odd';
$even = !$even;
}
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;
+}
+
+# '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;;
+}
+
# Backward Compatibility
# ----------------------
+function is_shown($piece) {
+ return isset($piece['args'][0]) && $piece['args'][0] == 'hide';
+}
+
+function is_shown_sub_template($piece) {
+ return is_sub_template($piece) and is_shown($piece);
+}
+
# Old-style templates don't show unless explicitly requested.
function tem_auto_hide(&$value, $key, $context) {
unset($context['data'][$key]);
# 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_array($piece) and $piece['pieces']) {
+ if(is_sub_template($piece)) {
if($piece['name'] == $name) {
- if($piece['args'][0] != 'hide') { # if we haven't already
+ 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));
}
if($tem) return $tem;
}
}
+ $false = false;
+ return $false;
}
class tem {
var $data;
function tem() {
- $this->template = array();
+ $this->template = array('pieces' => array());
$this->data = array();
- }
+ }
- function set($key, $value) {
+ function set($key, $value = true) {
$this->data[$key] = $value;
}
+ function sets($hash) {
+ foreach($hash as $key => $value) {
+ $this->set($key, $value);
+ }
+ }
+
function append($key, $value) {
+ if (!isset($this->data[$key])) {
+ $this->data[$key] = '';
+ }
$this->data[$key] .= $value;
}
}
function get($key) {
- return $this->data[$key];
+ if (isset($this->data[$key])) {
+ return $this->data[$key];
+ } else {
+ return;
+ }
}
function show($name) {
$tem = tem_is_old_sub($name, $this->template);
- $this->data[$name] .= fill_template($tem, $this->data);
+ if($tem) {
+ if (!isset($this->data[$name])) {
+ $this->data[$name] = '';
+ }
+ $this->data[$name] .= fill_template($tem, $this->data);
+ }
}
function show_separated($name) {
}
function load_str($str) {
- $this->template = parse_template($str);
+ $this->template =& parse_template($str);
}
function load($filename) {
- $this->template = parse_template_file($filename);
+ $this->template =& parse_template_file($filename);
}
function run($tem = false) {
# supporting both new and old semantics.
function merge($tem) {
# append expansions to $this->data (old style)
- $subs = $tem->top_subs();
+
+ $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);
+ 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() {
- return array_keys(top_sub_templates($this->template));
+ function top_sub_names($is_sub = 'is_sub_template') {
+ return array_keys(top_sub_templates($this->template, $is_sub));
}
- function top_subs() {
+ function top_subs($is_sub = 'is_sub_template') {
$ret = array();
- $names = $this->top_sub_names();
+ $names = $this->top_sub_names($is_sub);
foreach($names as $name) {
$ret[$name] = $this->get($name);
}
}
function tem_init() {
- if(!$GLOBALS['wfpl_template']) {
+ if(!isset($GLOBALS['wfpl_template']) || !$GLOBALS['wfpl_template']) {
$GLOBALS['wfpl_template'] = new tem();
}
}
$GLOBALS['wfpl_template']->prepend($key, $value);
}
-function tem_set($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);
$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_load_new($filename) {
- $old = $GLOBALS['wfpl_template'];
+ $old = isset($GLOBALS['wfpl_template']) ? $GLOBALS['wfpl_template'] : null;
$GLOBALS['wfpl_template'] = new tem();
$GLOBALS['wfpl_template']->load($filename);
return $old;
function tem_sub($name) {
tem_show($name);
}
-
-?>
Got questions, comments, patches, etc.? Contact Jason Woofenden