<?php

* template.inc

* $Id$

/**

* Template class. By Nathan Codding of the phpBB group.

* The interface was originally inspired by PHPLib templates,

* and the template file formats are quite similar.

*/

class Template {

// if it's a root-level variable, it'll be like this:

// $this->_tpldata[.][0][varname] == value

var $_tpldata = array();

// Hash of filenames for each template handle.

var $files = array();

// Root template directory.

var $root = "";

// this will hash handle names to the compiled code for that handle.

var $compiled_code = array();

// This will hold the uncompiled code for that handle.

var $uncompiled_code = array();

/**

* Constructor. Simply sets the root dir.

*/

{

$this->set_rootdir($root);

}

/**

* Sets the template root directory for this Template object.

{

{

return false;

}

$this->root = $dir;

return true;

}

* Sets the template filenames for handles. $filename_array

* should be a hash of handle => filename pairs.

*/

{

if (!is_array($filename_array))

{

}

reset($filename_array);

{

$this->files[$handle] = $this->make_filename($filename);

}

return true;

}

/**

* Load the file for the handle, compile the file,

* and run the compiled code. This will print out

{

if (!$this->loadfile($handle))

{

}

// actually compile the template now.

if (!isset($this->compiled_code[$handle]) || empty($this->compiled_code[$handle]))

{

// Actually compile the code now.

$this->compiled_code[$handle] = $this->compile($this->uncompiled_code[$handle]);

}

// Run the compiled code.

eval($this->compiled_code[$handle]);

return true;

}

/**

* Inserts the uncompiled code for $handle as the

* value of $varname in the root-level. This can be used

* template.

* Note that all desired assignments to the variables in $handle should be done

* BEFORE calling this function.

{

if (!$this->loadfile($handle))

{

}

// Compile it, with the "no echo statements" option on.

$code = $this->compile($this->uncompiled_code[$handle], true);

// turn it into a variable assignment.

$code = '$_str = \'' . $code . '\';';

// evaluate the variable assignment.

eval($code);

// assign the value of the generated variable to the given varname.

$this->assign_var($varname, $_str);

return true;

}

/**

* Block-level variable assignment. Adds a new block iteration with the given

* iteration.

*/

function assign_block_vars($blockname, $vararray)

{

if (strstr($blockname, '.'))

{

$blocks = explode('.', $blockname);

$blockcount = sizeof($blocks) - 1;

$str = '$this->_tpldata';

// We're adding a new iteration to this block with the given

// variable assignments.

$str .= '[\'' . $blocks[$blockcount] . '.\'][] = $vararray;';

// Now we evaluate this assignment we've built up.

eval($str);

}

// we were given.

$this->_tpldata[$blockname . '.'][] = $vararray;

}

return true;

}

/**

* Root-level variable assignment. Adds to current assignments, overriding

* any existing variable assignment with the same name.

reset ($vararray);

while (list($key, $val) = each($vararray))

{

}

return true;

}

/**

* Root-level variable assignment. Adds to current assignments, overriding

* any existing variable assignment with the same name.

function assign_var($varname, $varval)

{

$this->_tpldata['.'][0][$varname] = $varval;

}

* Generates a full path+filename for the given filename, which can either

* be an absolute name, or a name relative to the rootdir for this Template

* object.

*/

{

// Check if it's an absolute or relative path.

if (substr($filename, 0, 1) != '/')

{

$filename = $this->root . '/' . $filename;

}

if (!file_exists($filename))

{

die("Template->make_filename(): Error - file $filename does not exist");

}

return $filename;

}

/**

* If not already done, load the file for the given handle and populate

* the uncompiled_code[] hash with its code. Do not compile.

*/

{

// If the file for this handle is already loaded and compiled, do nothing.

if (isset($this->uncompiled_code[$handle]) && !empty($this->uncompiled_code[$handle]))

}

// If we don't have a file assigned to this handle, die.

{

die("Template->loadfile(): No file specified for handle $handle");

}

$filename = $this->files[$handle];

$str = implode("", @file($filename));

{

die("Template->loadfile(): File $filename for handle $handle is empty");

}

$this->uncompiled_code[$handle] = $str;

return true;

}

/**

* Compiles the given string of code, and returns

* the result in a string.

* If "do_not_echo" is true, the returned code will not be directly

* for use in assign_code_from_handle().

*/

function compile($code, $do_not_echo = false)

// replace \ with \\ and then ' with \'.

$code = str_replace('\\', '\\\\', $code);

$code = str_replace('\'', '\\\'', $code);

// change template varrefs into PHP varrefs

// This one will handle varrefs WITH namespaces

$varrefs = array();

preg_match_all('#\{(([a-z0-9\-_]+?\.)+?)([a-z0-9\-_]+?)\}#is', $code, $varrefs);

$namespace = $varrefs[1][$i];

$varname = $varrefs[3][$i];

$new = $this->generate_block_varref($namespace, $varname);

$code = str_replace($varrefs[0][$i], $new, $code);

}

// This will handle the remaining root-level varrefs

$code = preg_replace('#\{([a-z0-9\-_]*?)\}#is', '\' . $this->_tpldata[\'.\'][0][\'\1\'] . \'', $code);

// Break it up into lines.

$code_lines = explode("\n", $code);

$block_nesting_level = 0;

$block_names = array();

$block_names[0] = ".";

// Second: prepend echo ', append ' . "\n"; to each line.

$line_count = sizeof($code_lines);

for ($i = 0; $i < $line_count; $i++)

else

{

// This block is nested.

// Generate a namespace string for this block.

$namespace = implode('.', $block_names);

// strip leading period from root level..

$namespace = substr($namespace, 2);

// current indices of all parent blocks.

$varref = $this->generate_block_data_ref($namespace, false);

// Create the for loop code to iterate over this block.

$code_lines[$i] .= "\n" . 'for ($_' . $n[1] . '_i = 0; $_' . $n[1] . '_i < $_' . $n[1] . '_count; $_' . $n[1] . '_i++)';

$code_lines[$i] .= "\n" . '{';

}

// We have the end of a block.

unset($block_names[$block_nesting_level]);

$block_nesting_level--;

else

{

// This block is nested.

// Generate a namespace string for this block.

$namespace = implode('.', $block_names);

// strip leading period from root level..

$namespace = substr($namespace, 2);

// current indices of all parent blocks.

$varref = $this->generate_block_data_ref($namespace, false);

// Create the for loop code to iterate over this block.

$code_lines[$i] = '$_' . $m[1] . '_count = sizeof(' . $varref . ');';

$code_lines[$i] .= "\n" . 'for ($_' . $m[1] . '_i = 0; $_' . $m[1] . '_i < $_' . $m[1] . '_count; $_' . $m[1] . '_i++)';

$code_lines[$i] .= "\n" . '{';

}

}

else if (preg_match('#<!-- END (.*?) -->#', $code_lines[$i], $m))

}

}

}

// Bring it back into a single string of lines of code.

return $code ;

}

/**

* Generates a reference to the given variable inside the given (possibly nested)

* block namespace. This is a string of the form:

{

// Strip the trailing period.

$namespace = substr($namespace, 0, strlen($namespace) - 1);

// Get a reference to the data block for this namespace.

$varref = $this->generate_block_data_ref($namespace, true);

// Prepend the necessary code to stick this in an echo line.

$varref = '\' . ' . $varref;

// Append the variable reference.

$varref .= '[\'' . $varname . '\'] . \'';

return $varref;

}

/**

* (possibly nested) block namespace. This is a string of the form:

* $this->_tpldata['parent'][$_parent_i]['$child1'][$_child1_i]['$child2'][$_child2_i]...['$childN']

*

// Build up the string with everything but the last child.

for ($i = 0; $i < $blockcount; $i++)

{

}

// Add the block reference for the last child.

$varref .= '[\'' . $blocks[$blockcount] . '.\']';

{

$varref .= '[$_' . $blocks[$blockcount] . '_i]';

}

return $varref;

}