File Source for yapter.php

<?php
/**
* Yapter - Yet Another PHP Template Engine
*
* @package Yapter
* @version 3.0.0
* @copyright Copyright 2001-2006 Vincent Driessen
* @copyright Copyright 2006-2007 Kevin L. Papendick
* @author Vincent Driessen <nvie@users.sourceforge.net>
* @author Kevin L. Papendick <kevinp@polarlava.com>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @filesource
*/
/**
* Yapter warning level constant - Silent
* @see Yapter::setWarningLevel()
*/
define('E_YAPTER_NONE', 0);
/**
* Yapter warning level constant - Report notices
* @see Yapter::setWarningLevel()
*/
define('E_YAPTER_NOTICE', 1);
/**
* Yapter warning level constant - Report warnings
* @see Yapter::setWarningLevel()
*/
define('E_YAPTER_WARNING', 2);
/**
* Yapter warning level constant - Report errors
* @see Yapter::setWarningLevel()
*/
define('E_YAPTER_ERROR', 4);
/**
* Yapter warning level constant - Die on errors
* @see Yapter::setWarningLevel()
*/
define('E_YAPTER_DIE_ON_ERROR', 8);
/**
* Yapter warning level constant - All: Report errors, warnings and notices
* @see Yapter::setWarningLevel()
*/
define('E_YAPTER_ALL', 15);
/**
* Yapter - Yet Another PHP Template Engine
*
* @package Yapter
* @since V3.0.0
*/
class Yapter {
/**
* Document Root
*
* @var string
*/
var $_ROOT;
/**
* Ignore unknown variables?
*
* @var boolean
*/
var $ignore_unknown_vars;
/**
* Automatically hide unparsed blocks?
*
* @var boolean
*/
var $hide_unparsed_blocks;
/**
* Template content blocks
*
* $blox[blockname]['content'] holds the template's content
* $blox[blockname]['numlines'] holds the number of lines in the block
* $blox[blockname]['parsed'] holds an array with the parsed data
* $blox[$_ROOT] always holds the main template
* @var array
*/
var $blox = array();
/**
* Tracks all block definitions from which multiple block instances can be created.
*
* @var array
*/
var $blockDefs = array();
/**
* Array of variables available to all blocks
*
* @var array
*/
var $vars;
/**
* Warning level verbosity
*
* @see setWarningLevel()
* @var string
*/
var $warning_level;
/**
* Script start time used to calculate debug execution time.
*
* @var float
*/
var $startTime;
/**
* Declared variables that were not set.
*
* @var array
*/
var $missing_var_list;
/**
* Yapter Constructor
*
* @param string $file The fully pathed template file
* @param int $level The warning level
*/
function Yapter($file, $level = E_YAPTER_ALL)
{
$this->setWarningLevel((int) $level);
$this->startTime = $this->getmicrotime();
$this->setIgnoreUnknownVars(FALSE);
$this->setHideUnparsedBlocks(FALSE);
$this->addBlockFromFile('__DOCUMENT_ROOT', $file);
$this->vars = array();
$this->missing_var_list = array();
}
/**
* Error handler
*
* @param int $line_num Line number.
* @param string $msg The error message.
*/
function error($line_num, $msg)
{
if ($this->getWarningLevel() & E_YAPTER_ERROR) {
trigger_error('[' . date('Y-m-d H:i:s') . '] Yapter (Line ' . $line_num . '): ' . $msg, E_USER_ERROR);
if ($this->getWarningLevel() & E_YAPTER_DIE_ON_ERROR) {
exit;
}
}
}
/**
* Warning handler
*
* @param int $line_num Line number.
* @param string $msg The warning message.
*/
function warning($line_num, $msg)
{
if ($this->getWarningLevel() & E_YAPTER_WARNING) {
trigger_error('[' . date('Y-m-d H:i:s') . '] Yapter (Line ' . $line_num . '): ' . $msg, E_USER_WARNING);
}
}
/**
* Notice handler
*
* @param int $line_num Line number.
* @param string $msg The notice message.
*/
function notice($line_num, $msg)
{
if ($this->getWarningLevel() & E_YAPTER_NOTICE) {
trigger_error('[' . date('Y-m-d H:i:s') . '] Yapter (Line ' . $line_num . '): ' . $msg, E_USER_NOTICE);
}
}
/**
* Sets the level of verbosity of error/warning/notices that Yapter displays.
*
* @param int The warning level
*/
function setWarningLevel($level)
{
$this->warning_level = $level;
}
/**
* Gets the level of verbosity of error/warning/notices that Yapter displays.
*/
function getWarningLevel()
{
return $this->warning_level;
}
/**
* Sets weather to ignore unknown template variables.
*
* @param boolean $a
*/
function setIgnoreUnknownVars($a)
{
$this->ignore_unknown_vars = $a;
}
/**
* Gets weather to ignore unknown template variables.
*
* @return boolean
*/
function getIgnoreUnknownVars()
{
return $this->ignore_unknown_vars;
}
/**
* Sets weather to hide unparsed template blocks.
*
* @param boolean $a
*/
function setHideUnparsedBlocks($a)
{
$this->hide_unparsed_blocks = $a;
}
/**
* Gets weather to hide unparsed template blocks.
*
* @return boolean
*/
function getHideUnparsedBlocks()
{
return $this->hide_unparsed_blocks;
}
/**
* Issue warning the first time an assigned variable is found, but not set.
*
* @param string $varname The name of the unset template variable.
*/
function warnVarNotSet($varname)
{
if (!in_array($varname, $this->getMissingVarList())) {
$this->setMissingVar($varname);
$this->warning(__LINE__, 'Variable "' . htmlspecialchars($varname) . '" found, but never assigned a value ');
}
}
/**
* List of variables that were found to not be set during parsing.
*
* @param string $a The name of the unset template variable.
*/
function setMissingVar($varname)
{
if (!is_array($this->missing_var_list)) {
$this->missing_var_list = array();
}
$this->missing_var_list[] = $varname;
if (!in_array($varname, $this->missing_var_list)) {
$this->missing_var_list[] = $varname; // Add it to the list...
// ...and print a warning once.
$this->warning(__LINE__, 'Variable "' . htmlspecialchars($varname) . '" found, but never assigned a value ');
}
}
function getMissingVarList()
{
if (!is_array($this->missing_var_list)) {
$this->missing_var_list = array();
}
return $this->missing_var_list;
}
/**
* Adds a new block to the blox-array
*
* @param string $blockname The name of the block.
* @param string $content The content of the block.
*/
function addBlock($blockname, $content)
{
$this->blox[$blockname]['content'] = $content;
$this->blox[$blockname]['numlines'] = count($this->blox[$blockname]['content']);
$this->blox[$blockname]['parsed'] = '';
$this->prepare($blockname);
}
/**
* Adds a new block, filling it with the specified's file contents
*
* @param string $blockname The name of the block.
* @param string $file The file containing the contents for the block.
*/
function addBlockFromFile($blockname, $file)
{
$content = @file($file) or $this->error(__LINE__, 'Cannot open and read template file ' . htmlspecialchars($file) . ' for addBlockFromFile() ');
$this->addBlock($blockname, $content);
}
/**
* Adds a block definition to the block-definition array from which other blocks can be copied
* @param string $blockdef The name of an existing block.
* @param string $content The content of the block definition.
*/
function addBlockDef($blockdef, $content)
{
/*
TODO: Should this be culled? -klp
if (isset($this->blockDefs[$blockdef])) {
$this->error(__LINE__, 'Block "' . htmlspecialchars($blockdef) . '" already exist and cannot be redefine ');
} else {
$this->blockDefs[$blockdef] = $content;
}
*/
$this->blockDefs[$blockdef] = $content;
}
/**
* Copies a block from the block definition array
* @param string $blockname The name of the block.
* @param string $blockdef The name of an existing defined block.
*/
function addBlockFromDef($blockname, $blockdef)
{
$this->addBlock($blockname, $this->blockDefs[$blockdef]);
}
/**
* Handles subprocessing of templates found in the main template file
*
* @param string $blockname The name of the block.
*/
function prepare($blockname)
{
$currblockcontents = array();
$block = &$this->blox[$blockname];
for ($i = 0; $i < $block['numlines']; $i++) {
if (isset($block['content'][$i])) {
$line = $block['content'][$i];
} else {
continue;
}
// Try to find a tag-definition on this line
if (preg_match('/\[(INCLUDE|BLOCK|END|REUSE|SET) ([A-Za-z0-9_.\/-]+)( AS ([A-Za-z0-9_-]+))?]/', $line, $matches)) {
$type = $matches[1];
$name = (!empty($matches[4])) ? $matches[4] : $matches[2];
if ($type == 'END' && !isset($currblockdef)) {
$this->error(__LINE__, '"[END ' . $name . ']" found without matching "[BLOCK ' . $name . ']" or "[SET ' . $name . ']" ');
}
if ($type == 'END' && $matches[2] == $currblockdef) {
if (isset($matches[4])) {
$this->error(__LINE__, 'Given "AS" parameter not allowed in END tags ');
}
// End the current block definition: add the block to the blox-array
if (isset($currblockdef) && isset($currblockcontents) && isset($currblockname)) {
$this->addBlockDef($currblockdef, $currblockcontents);
$this->addBlockFromDef($currblockname, $currblockdef);
}
// Now, try to remove the block from the template definition, replacing it with a var
for ($j = $i; $j >= $currblockstart; $j--) {
if ($j == $currblockstart && $currblocktype == 'BLOCK') {
$block['content'][$j] = "{" . $currblockname . "}";
} else {
unset($block['content'][$j]);
}
}
// Reset for further preparing.
unset($currblocktype);
unset($currblockstart);
unset($currblockname);
unset($currblockdef);
$currblockcontents = array();
} elseif (($type == 'SET' || $type == 'BLOCK') && !isset($currblockname)) {
if ($type == 'BLOCK') {
// Start BLOCK definition
$currblocktype = $type;
$currblockstart = $i;
$currblockname = $name;
$currblockdef = $matches[2];
} else {
// Start SET definition
if (isset($matches[4])) {
$this->error(__LINE__, 'Given "AS" parameter not allowed in SET tags ');
}
$currblocktype = $type;
$currblockstart = $i;
$currblockname = $matches[2];
$currblockdef = $matches[2];
}
} elseif ($type == 'INCLUDE' && !isset($currblockname)) {
// Make this line a variable...
$block['content'][$i] = '{' . $name . "}\n";
// ...and include the given file...
$this->addBlockFromFile($name, $matches[2]);
} elseif ($type == 'REUSE' && !isset($currblockname)) {
if (!isset($matches[4])) {
$this->error(__LINE__, 'Missing required "AS" parameter in [REUSE ' . $name . '] tag ');
}
// Make this line a variable...
$block['content'][$i] = '{' . $matches[4] . "}\n";
// ...and get this REUSE value from the block definition list...
$this->addBlockFromDef($matches[4], $matches[2]);
} elseif ($currblockname != $name) {
if ($currblockname) {
$currblockcontents[] = $line;
}
}
} else {
// No tag-definition... just normal text so do nothing here
if (!empty($currblockname)) {
$currblockcontents[] = $line;
}
}
}
}
/**
* Parses the specified block, filling variables and nested blockdefs
*
* @param string $blockname The name of the block.
* @return array $this->blox[$blockname]['parsed'] Parsed block
*/
function parse($blockname = '')
{
if (!$blockname) {
$blockname = $this->_ROOT;
}
if (!isset($this->blox[$blockname])) {
$this->error(__LINE__, 'Unable to parse block because block "' . htmlspecialchars($blockname) . '" does not exist ');
}
$block = &$this->blox[$blockname];
$parsed = $block['content'];
// Loop through all the lines of the template and parse variables one-by-one
for ($i = 0; $i < $block['numlines']; $i++) {
if (!isset($parsed[$i])) {
continue;
}
$line = $parsed[$i];
// Look for variables in this line, processing it character-by-character
unset($start);
unset($buffer);
for ($j = 0; $j < strlen($line); $j++) {
$char = $line[$j];
if (!isset($start) && $char == '{') {
$start = $j;
} elseif (isset($start) && $char == '}') {
// The sequence {} is not a valid variable value
if (!isset($buffer)) {
unset($start);
continue;
} else {
// Gotcha! Now replace this variable with its contents
// First, check to see if it's a variable or a block that has to be parsed
if (isset($this->vars[$buffer])) {
$value = $this->vars[$buffer];
} elseif (isset($this->blox[$buffer])) {
if ($this->blox[$buffer]['parsed']) {
// The value must be filled with the parsed data from the $buffer block
$value = @implode('', $this->blox[$buffer]['parsed']);
} elseif ($this->getWarningLevel() & $this->getHideUnparsedBlocks()) {
// Automaticly hide unparsed bloks
$value = "";
} else {
// Make the recursive call now
$value = @implode('', $this->parse($buffer));
}
} else {
// No variable or block name found by the name of $buffer
if ($this->getIgnoreUnknownVars()) {
// Ignore, replace with an empty string.
$value = '';
} else {
// Warn and continue.
$this->warnVarNotSet($buffer);
unset($start);
unset($buffer);
continue;
}
}
$part1 = substr($line, 0, $start);
$part2 = substr($line, $start + strlen($buffer) + 2);
$line = $part1 . $value . $part2;
$j += strlen($value) - (strlen($buffer) + 2);
unset($start);
unset($buffer);
}
} elseif (isset($start)) {
// Check to see $char is a proper character (range: [A-Za-z0-9_./-])
// In Yapter 2.13b2, I've added the '/' char as well, to support inclusion
// from Unix paths, like '../../foo.tpl'
if (($char >= 'a' && $char <= 'z') || ($char >= '0' && $char <= '9') || ($char >= 'A' && $char <= 'Z') || ($char == '_') || ($char == '.') || ($char == '-') || ($char == '/')) {
if (!empty($buffer)) {
$buffer .= $char;
} else {
$buffer = $char;
}
} else {
unset($start);
unset($buffer);
}
}
}
$parsed[$i] = $line;
}
if (is_array($this->blox[$blockname]['parsed'])) {
$this->blox[$blockname]['parsed'] = array_merge($this->blox[$blockname]['parsed'], $parsed);
} else {
$this->blox[$blockname]['parsed'] = (array) $parsed;
}
return $this->blox[$blockname]['parsed'];
}
/**
* Assigns a value to a variable ({varname}).
* @param string $varname Template variable name.
* @param string|int$value the value of the template variable.
*/
function set($varname, $value)
{
if (isset($value)) {
$this->vars[$varname] = $value;
} else {
$this->warning(__LINE__, 'Trying to set "' . htmlspecialchars($varname) . '" to NULL. Variable not set ');
}
}
/**
* Assigns values to multiple variables
*
* @param array $variables Associative array (var_name => var_value) of template variables.
*/
function setVars($variables)
{
if (!is_array($variables)) {
$this->error('Value passed to setVars() is not an array ');
}
foreach($variables as $varname => $value) {
$this->set($varname, $value);
}
}
/**
* Assigns the contents of a file to a variable ({varname}).
*
* @param string $varname Template variable name.
* @param string $file The file containing the contents for the variable.
*/
function setFile($varname, $filename)
{
if (!file_exists($filename) || !is_readable($filename)) {
$this->error(__LINE__, 'The file "' . htmlspecialchars($filename) . '" required to set the "' . htmlspecialchars($varname) . '" variable does not exits or is unreadable ');
}
$value = implode('', file($filename));
$this->set($varname, $value);
}
/**
* Gets the value of a variable.
*
* @param string $varname Template variable name.
* @return string|int|booleanThe value of the variable or FALSE if unset.
*/
function getVar($varname)
{
if ($this->vars[$varname]) {
return $this->vars[$varname];
} else {
return FALSE;
}
}
/**
* Gets the content of a block.
*
* @param string $blockname The name of the block.
* @return string|booleanThe contents of the block or FALSE if unset.
*/
function getBlockContent($blockname)
{
if ($this->$blox[$blockname]['content']) {
return @implode('', $this->$blox[$blockname]['content']);
} else {
return FALSE;
}
}
/**
* Replaces the contents of one block with the contents of another.
*
* @param string $blockname The name of the block to be replaced.
* @param string $replace_by_block The name of the block to duplicate.
*/
function replace($block, $replace_by_block)
{
if (!isset($this->blox[$block])) {
$this->error(__LINE__, 'Block "' . htmlspecialchars($block) . '" does not exist so it cannot be replaced by the "' . htmlspecialchars($replace_by_block) . '" block ');
}
if (!isset($this->blox[$replace_by_block])) {
$this->error(__LINE__, 'Block "' . htmlspecialchars($replace_by_block) . '" does not exist so it cannot be used to replace the "' . htmlspecialchars($block) . '" block ');
}
$this->blox[$block]['content'] = $this->blox[$replace_by_block]['content'];
$this->blox[$block]['numlines'] = $this->blox[$replace_by_block]['numlines'];
}
/**
* Hides all the contents of the specified block.
*
* @param string $block The name of the block.
*/
function hide($block)
{
if (!isset($this->blox[$block])) {
$this->error(__LINE__, 'Block "' . htmlspecialchars($block) . '" does not exist so it cannot be hidden ');
}
$this->blox[$block]['content'] = array();
$this->blox[$block]['numlines'] = 0;
}
/**
* Resets the parsed data to an empty string and sets the block as "unparsed".
*
* @param string $blockname The name of the block.
*/
function clear($blockname)
{
if (!isset($this->blox[$blockname])) {
$this->error(__LINE__, 'Block "'.htmlspecialchars($blockname).'" does not exist so it cannot be cleared ');
}
$this->blox[$blockname]['parsed'] = '';
// often, a variable is set whenever a block should be discarded...
// now reset such a variable to make sure the block is not overriden
unset($this->vars[$blockname]);
}
/**
* Gets the parsed content of a block or the ROOT (complete) template.
*
* @param string $blockname The name of the block.
* @return string|booleanThe parsed contents of the block or FALSE if unset.
*/
function getContents($blockname = '')
{
if ($blockname == '') {
$blockname = $this->_ROOT;
}
$parsed = $this->blox[$blockname]['parsed'];
if ($parsed) {
return implode('', $parsed);
} else {
return FALSE;
}
}
/**
* Prints the full template contents.
*/
function spit()
{
echo $this->getContents();
}
/**
* Get the Unix timestamp in seconds.
*
* @link http://www.php.net/manual/en/function.microtime.php
* @return float
*/
function getmicrotime()
{
if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
return 0.0;
} else {
list($usec, $sec) = explode(' ', microtime());
return ((float)$usec + (float)$sec);
}
}
/**
* Gets the time in seconds required to parse the template.
*
* @return float
*/
function execTime()
{
return round($this->getmicrotime() - $this->startTime, 5);
}
/**
* Gets the debug string with the time required to parse the template.
*
* @return string
*/
function executionTime()
{
echo "<p>\n\nThe execution time is <b>".$this->execTime()."</b> seconds.<br>\n";
}
}
/****************
* Legacy Support *
******************/
/**
* Yapter constant - Ignore unknown variables
* @deprecated Use Yapter::setIgnoreUnknownVars()
* @see Yapter::setIgnoreUnknownVars()
*/
define('E_YAPTER_IGN_UNKNOWN_VARS', 16);
/**
* Yapter constant - Automaticly hide unparsed blocks
* @deprecated Use Yapter::setHideUnparsedBlocks()
* @see Yapter::setHideUnparsedBlocks()
*/
define('E_YAPTER_AUTO_HIDE_BLOCK', 32);
/**
* Yapter - Yet Another PHP Template Engine (Legacy Class)
*
* @package Yapter
* @see Yapter class
* @deprecated This is for legacy support only, new developement should use Yapter class instead.
*/
class Template extends Yapter {
/**
* Yapter Template Constructor
*
* @param string $file The fully pathed template file
* @param int|boolean$level The warning|(deprecated) debug level
* @see Yapter::setWarningLevel()
* @deprecated This is for legacy support only, new developement should use the Yapter class constructor.
*/
function Template($file, $level = E_YAPTER_ALL)
{
if (is_bool($level)) {
//
// Rationale:
// =========
// Older Yapter versions had the possibility of turning
// on the so called "debug mode" with a bool parameter
// as the second argument to this constructor.
// However, since debug mode was dropped and the
// warning level support was built in, it was a logical
// step of replacing the second parameter.
//
// However, to prevent people from making mistakes,
// we'll check if the user passed a boolean parameter.
// If so, he or she is probably using debug mode, and
// we'll issue a notice in these cases.
//
// Thanks to Ivo Koster.
//
$level = E_YAPTER_ALL;
$bad_debug = TRUE;
}
$this->Yapter($file, $level);
if (isset($bad_debug)) {
$this->notice(__LINE__, 'Debug mode has not been supported since V2.12, use setWaringLevel() instead ');
}
//Support deprecated constants...
if ($this->getWarningLevel() & E_YAPTER_IGN_UNKNOWN_VARS) {
$this->setIgnoreUnknownVars(TRUE);
}
if ($this->getWarningLevel() & E_YAPTER_AUTO_HIDE_BLOCK) {
$this->setHideUnparsedBlocks(TRUE);
}
}
/**
* Sets whether to parse unknown variables.
*
* @param boolean $a
* @deprecated Use Yapter::setIgnoreUnknownVars()
* @see Yapter::setIgnoreUnknownVars()
*/
function setParseMode($a)
{
$this->setIgnoreUnknownVars((bool) $a);
}
}
?>

Documentation generated on Tue, 27 Feb 2007 22:01:39 -0500 by phpDocumentor 1.3.1

Source for file yapter.php