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) {
$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(last($args) == '{') { # open block
array_pop($args); # drop '{'
- if(!is_string(last($tem['pieces']))) $tem['pieces'][] = '';
$tem =& tem_push($tem); # create a new sub-template
$tem['parent']['pieces'][] =& $tem; # as a piece of the parent
$tem['name'] = $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.");
}
$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) {
- if(!$context) {
- $context =& tem_push($context);
- $context['data'] =& $data;
- }
+ $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 =& tem_push($context);
- $context['data'] =& $row;
- $context['rows'] =& $rows;
- $output .= fill_template($tem, $row, $context);
- $context =& $context['parent'];
-
+ $context['cur'] = $key;
+ $output .= fill_template($tem, $row, $context);
}
} else { # variable
$output .= tem_encoded_data($tem, $context);
}
}
+ $context =& $context['parent'];
return $output;
}
# 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'])) {
} while($scope = $scope['parent']);
# not found; return empty scope.
- return array('parent' => $context);
+ $refs[] = array();
+ $ret = array();
+ $ret['parent'] =& $context;
+ $ret['data'] =& last($refs);
+ return $ret;
}
function tem_get_data($key, $context) {
# 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($tag, $context)
+function &tem_row_data($tem, $context)
{
- $key = $tag['name'];
- if(count($tag['args'])) {
- $func = "tem_auto_" . $tag['args'][0];
- function_exists($func)
- or die("ERROR: template auto function '$func' not found.<br>\n");
- }
+ $key = $tem['name'];
$scope = tem_data_scope($key, $context);
- if($func) $value = $func($key, $scope);
+ 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($auto_func) $value = $auto_func($scope['data'][$key], $key, $scope);
else $value = $scope['data'][$key];
$rows = tem_data_as_rows($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) {
+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;
$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;
# 'sep' (separator) sections will be shown for all but the last parent row.
# Sample usage:
-# <!--~rows~-->
-# <!--~row~-->
+# <!--~rows {~-->
+# <!--~row {~-->
# row content...
-# <!--~separator sep {~--><hr><!--~separator }"-->
-# <!--~row~-->
-# <!--~rows~-->
+# <!--~separator sep {~--><hr><!--~}~-->
+# <!--~}~-->
+# <!--~}~-->
#
-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_auto_sep(&$value, $key, $context) {
+ $rows =& $context['parent']['parent'];
+ if($rows['cur'] != count($rows['rows'])-1) # last row?
+ return $value = 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
+}
+
+# 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
}
# 'show' sections will be shown unless the corresponding data value
-# is false. We check only for false; 0 or '' will not work.
+# is false (only false, not 0 or '' or array()).
-function tem_auto_show($key, $context) {
- if($context['data'][$key] !== false)
- return tem_data_as_rows(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($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;
+function tem_auto_evenodd(&$values) {
+ $even = true;
+ if($values) foreach($values as &$value) {
+ $value['evenodd'] = $even ? 'even' : 'odd';
+ $even = !$even;
+ }
+ return $values;
+}
+
+
+
+
+
+# Backward Compatibility
+# ----------------------
+
+function is_shown($piece) {
+ return $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]);
+ return false;
+}
+
+# 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 false;
+}
+
+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);
+ }
+ }
+
+ 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);
}
- return tem_data_as_rows($rows);
+
+ 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);
+ }
+
+ # 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) {
+ 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_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);
}
?>
Got questions, comments, patches, etc.? Contact Jason Woofenden