X-Git-Url: https://jasonwoof.com/gitweb/?p=wfpl.git;a=blobdiff_plain;f=template.php;h=077aa8daf4547b33693af1df1f008811e41862db;hp=396819d20d4ad2db754eaa5815690d66c45c5754;hb=HEAD;hpb=bd1f2c2ee4f8edf6139b811ec3fe746700409723
diff --git a/template.php b/template.php
index 396819d..077aa8d 100644
--- a/template.php
+++ b/template.php
@@ -1,19 +1,9 @@
-#
-# 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 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
@@ -37,9 +27,9 @@
# 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
@@ -73,14 +63,14 @@ function &parse_template($string) {
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) {
@@ -100,15 +90,16 @@ function &parse_template($string) {
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);
@@ -157,12 +148,14 @@ function &tem_push(&$stack = NULL) {
# 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);
+ } else return array($value);
} elseif($value || $value === 0 || $value === '0' || $value === '') {
# value -- expand sub-template once using only parent values
return array(array());
@@ -183,19 +176,19 @@ function tem_data_scope($key, $context) {
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.
@@ -204,41 +197,60 @@ function &tem_row_data($tem, $context)
{
$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.
\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.
\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.
\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.
\n");
- }
- return $value;
+ return tem_apply_encodings($key, $value, $tag['args']);
}
function is_sub_template(&$piece) {
- return is_array($piece) and $piece['pieces'];
+ return is_array($piece) && isset($piece['pieces']);
}
function is_value_slot(&$piece) {
- return is_array($piece) and !$piece['pieces'];
+ return is_array($piece) && !isset($piece['pieces']);
}
# Return a hash containing the top-level sub-templates of tem.
@@ -257,20 +269,20 @@ function top_sub_templates($tem, $is_sub = 'is_sub_template') {
function merge_sub_templates(&$main, &$subs) {
foreach($main['pieces'] as &$piece) {
if(is_array($piece)) { # not just text
- if($piece['pieces']) {
+ if(isset($piece['pieces']) && $piece['pieces']) {
# a sub-template in main
merge_sub_templates($piece, $subs);
} else {
# a value-slot in main
- $sub = $subs[$piece['name']];
- if($sub and $sub['args'][0] != 'hide') {
+ $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;
}
}
}
}
- return $out;
}
# Replace values in $main with top-level templates from $tem.
@@ -300,42 +312,56 @@ function merge_templates(&$main, &$tem) {
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 $value = true; # show once
+ 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 $value = true; # show once
+ return true; # show once
}
# 'show' sections will be shown unless the corresponding data
# value === false
-
function tem_auto_show(&$value) {
- if($value === null) $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 === '') $value = null;
+ 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 = true;
if($values) foreach($values as &$value) {
@@ -345,6 +371,27 @@ function tem_auto_evenodd(&$values) {
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;;
+}
+
@@ -353,7 +400,7 @@ function tem_auto_evenodd(&$values) {
# ----------------------
function is_shown($piece) {
- return $piece['args'][0] == 'hide';
+ return isset($piece['args'][0]) && $piece['args'][0] == 'hide';
}
function is_shown_sub_template($piece) {
@@ -385,7 +432,8 @@ function &tem_is_old_sub($name, &$template) {
if($tem) return $tem;
}
}
- return false;
+ $false = false;
+ return $false;
}
class tem {
@@ -397,11 +445,20 @@ class tem {
$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;
}
@@ -414,12 +471,19 @@ class tem {
}
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);
if($tem) {
+ if (!isset($this->data[$name])) {
+ $this->data[$name] = '';
+ }
$this->data[$name] .= fill_template($tem, $this->data);
}
}
@@ -495,7 +559,7 @@ class tem {
}
function tem_init() {
- if(!$GLOBALS['wfpl_template']) {
+ if(!isset($GLOBALS['wfpl_template']) || !$GLOBALS['wfpl_template']) {
$GLOBALS['wfpl_template'] = new tem();
}
}
@@ -510,11 +574,16 @@ function tem_prepend($key, $value) {
$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);
@@ -566,7 +635,7 @@ function tem_top_sub_names() {
}
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;
@@ -576,5 +645,3 @@ function tem_load_new($filename) {
function tem_sub($name) {
tem_show($name);
}
-
-?>