/src/lib/HTML/Template/IT.php
PHP | 1127 lines | 461 code | 115 blank | 551 comment | 63 complexity | 2af8d7f10f7819293b83f55237fedf52 MD5 | raw file
- <?php
- /**
- * Integrated Template - IT
- *
- * PHP version 4
- *
- * Copyright (c) 1997-2007 Ulf Wendel, Pierre-Alain Joye,
- * David Soria Parra
- *
- * This source file is subject to the New BSD license, That is bundled
- * with this package in the file LICENSE, and is available through
- * the world-wide-web at
- * http://www.opensource.org/licenses/bsd-license.php
- * If you did not receive a copy of the new BSDlicense and are unable
- * to obtain it through the world-wide-web, please send a note to
- * pajoye@php.net so we can mail you a copy immediately.
- *
- * Author: Ulf Wendel <ulf.wendel@phpdoc.de>
- * Pierre-Alain Joye <pajoye@php.net>
- * David Soria Parra <dsp@php.net>
- *
- * @category HTML
- * @package HTML_Template_IT
- * @author Ulf Wendel <uw@netuse.de>
- * @license BSD http://www.opensource.org/licenses/bsd-license.php
- * @version CVS: $Id: IT.php,v 1.27 2008/11/14 23:57:17 kguest Exp $
- * @link http://pear.php.net/packages/HTML_Template_IT
- * @access public
- */
- require_once 'PEAR.php';
- define('IT_OK', 1);
- define('IT_ERROR', -1);
- define('IT_TPL_NOT_FOUND', -2);
- define('IT_BLOCK_NOT_FOUND', -3);
- define('IT_BLOCK_DUPLICATE', -4);
- define('IT_UNKNOWN_OPTION', -6);
- /**
- * Integrated Template - IT
- *
- * Well there's not much to say about it. I needed a template class that
- * supports a single template file with multiple (nested) blocks inside and
- * a simple block API.
- *
- * The Isotemplate API is somewhat tricky for a beginner although it is the best
- * one you can build. template::parse() [phplib template = Isotemplate] requests
- * you to name a source and a target where the current block gets parsed into.
- * Source and target can be block names or even handler names. This API gives you
- * a maximum of fexibility but you always have to know what you do which is
- * quite unusual for php skripter like me.
- *
- * I noticed that I do not any control on which block gets parsed into which one.
- * If all blocks are within one file, the script knows how they are nested and in
- * which way you have to parse them. IT knows that inner1 is a child of block2,
- * there's no need to tell him about this.
- *
- * <table border>
- * <tr>
- * <td colspan=2>
- * __global__
- * <p>
- * (hidden and automatically added)
- * </td>
- * </tr>
- * <tr>
- * <td>block1</td>
- * <td>
- * <table border>
- * <tr>
- * <td colspan=2>block2</td>
- * </tr>
- * <tr>
- * <td>inner1</td>
- * <td>inner2</td>
- * </tr>
- * </table>
- * </td>
- * </tr>
- * </table>
- *
- * To add content to block1 you simply type:
- * <code>$tpl->setCurrentBlock("block1");</code>
- * and repeat this as often as needed:
- * <code>
- * $tpl->setVariable(...);
- * $tpl->parseCurrentBlock();
- * </code>
- *
- * To add content to block2 you would type something like:
- * <code>
- * $tpl->setCurrentBlock("inner1");
- * $tpl->setVariable(...);
- * $tpl->parseCurrentBlock();
- *
- * $tpl->setVariable(...);
- * $tpl->parseCurrentBlock();
- *
- * $tpl->parse("block1");
- * </code>
- *
- * This will result in one repition of block1 which contains two repitions
- * of inner1. inner2 will be removed if $removeEmptyBlock is set to true
- * which is the default.
- *
- * Usage:
- * <code>
- * $tpl = new HTML_Template_IT( [string filerootdir] );
- *
- * // load a template or set it with setTemplate()
- * $tpl->loadTemplatefile( string filename [, boolean removeUnknownVariables, boolean removeEmptyBlocks] )
- *
- * // set "global" Variables meaning variables not beeing within a (inner) block
- * $tpl->setVariable( string variablename, mixed value );
- *
- * // like with the Isotemplates there's a second way to use setVariable()
- * $tpl->setVariable( array ( string varname => mixed value ) );
- *
- * // Let's use any block, even a deeply nested one
- * $tpl->setCurrentBlock( string blockname );
- *
- * // repeat this as often as you need it.
- * $tpl->setVariable( array ( string varname => mixed value ) );
- * $tpl->parseCurrentBlock();
- *
- * // get the parsed template or print it: $tpl->show()
- * $tpl->get();
- * </code>
- *
- * @category HTML
- * @package HTML_Template_IT
- * @author Ulf Wendel <uw@netuse.de>
- * @license BSD http://www.opensource.org/licenses/bsd-license.php
- * @link http://pear.php.net/packages/HTML_Template_IT
- * @access public
- */
- class HTML_Template_IT
- {
- /**
- * Contains the error objects
- * @var array
- * @access public
- * @see halt(), $printError, $haltOnError
- */
- var $err = array();
- /**
- * Clear cache on get()?
- * @var boolean
- * @acces public
- */
- var $clearCache = false;
- /**
- * First character of a variable placeholder ( _{_VARIABLE} ).
- * @var string
- * @access public
- * @see $closingDelimiter, $blocknameRegExp, $variablenameRegExp
- */
- var $openingDelimiter = '{';
- /**
- * Last character of a variable placeholder ( {VARIABLE_}_ ).
- * @var string
- * @access public
- * @see $openingDelimiter, $blocknameRegExp, $variablenameRegExp
- */
- var $closingDelimiter = '}';
- /**
- * RegExp matching a block in the template.
- * Per default "sm" is used as the regexp modifier, "i" is missing.
- * That means a case sensitive search is done.
- * @var string
- * @access public
- * @see $variablenameRegExp, $openingDelimiter, $closingDelimiter
- */
- var $blocknameRegExp = '[\.0-9A-Za-z_-]+';
- /**
- * RegExp matching a variable placeholder in the template.
- * Per default "sm" is used as the regexp modifier, "i" is missing.
- * That means a case sensitive search is done.
- * @var string
- * @access public
- * @see $blocknameRegExp, $openingDelimiter, $closingDelimiter
- */
- var $variablenameRegExp = '[\.0-9A-Za-z_-]+';
- /**
- * RegExp used to find variable placeholder, filled by the constructor.
- * @var string Looks somewhat like @(delimiter varname delimiter)@
- * @access private
- * @see IntegratedTemplate()
- */
- var $variablesRegExp = '';
- /**
- * RegExp used to strip unused variable placeholder.
- * @access private
- * @brother $variablesRegExp
- */
- var $removeVariablesRegExp = '';
- /**
- * Controls the handling of unknown variables, default is remove.
- * @var boolean
- * @access public
- */
- var $removeUnknownVariables = true;
- /**
- * Controls the handling of empty blocks, default is remove.
- * @var boolean
- * @access public
- */
- var $removeEmptyBlocks = true;
- /**
- * RegExp used to find blocks an their content, filled by the constructor.
- * @var string
- * @see IntegratedTemplate()
- * @access private
- */
- var $blockRegExp = '';
- /**
- * Name of the current block.
- * @var string
- * @access private
- */
- var $currentBlock = '__global__';
- /**
- * Content of the template.
- * @var string
- * @access private
- */
- var $template = '';
- /**
- * Array of all blocks and their content.
- *
- * @var array
- * @see findBlocks()
- * @access private
- */
- var $blocklist = array();
- /**
- * Array with the parsed content of a block.
- *
- * @var array
- * @access private
- */
- var $blockdata = array();
- /**
- * Array of variables in a block.
- * @var array
- * @access private
- */
- var $blockvariables = array();
- /**
- * Array of inner blocks of a block.
- * @var array
- * @access private
- */
- var $blockinner = array();
- /**
- * List of blocks to preverse even if they are "empty".
- *
- * This is something special. Sometimes you have blocks that
- * should be preserved although they are empty (no placeholder replaced).
- * Think of a shopping basket. If it's empty you have to drop a message to
- * the user. If it's filled you have to show the contents of
- * the shopping baseket. Now where do you place the message that the basket
- * is empty? It's no good idea to place it in you applications as customers
- * tend to like unecessary minor text changes. Having another template file
- * for an empty basket means that it's very likely that one fine day
- * the filled and empty basket templates have different layout. I decided
- * to introduce blocks that to not contain any placeholder but only
- * text such as the message "Your shopping basked is empty".
- *
- * Now if there is no replacement done in such a block the block will
- * be recognized as "empty" and by default ($removeEmptyBlocks = true) be
- * stripped off. To avoid thisyou can now call touchBlock() to avoid this.
- *
- * The array $touchedBlocks stores a list of touched block which must not
- * be removed even if they are empty.
- *
- * @var array $touchedBlocks
- * @see touchBlock(), $removeEmptyBlocks
- * @access private
- */
- var $touchedBlocks = array();
- /**
- * List of blocks which should not be shown even if not "empty"
- * @var array $_hiddenBlocks
- * @see hideBlock(), $removeEmptyBlocks
- * @access private
- */
- var $_hiddenBlocks = array();
- /**
- * Variable cache.
- *
- * Variables get cached before any replacement is done.
- * Advantage: empty blocks can be removed automatically.
- * Disadvantage: might take some more memory
- *
- * @var array
- * @see setVariable(), $clearCacheOnParse
- * @access private
- */
- var $variableCache = array();
- /**
- * Clear the variable cache on parse?
- *
- * If you're not an expert just leave the default false.
- * True reduces memory consumption somewhat if you tend to
- * add lots of values for unknown placeholder.
- *
- * @var boolean
- * @access public
- */
- var $clearCacheOnParse = false;
- /**
- * Root directory for all file operations.
- * The string gets prefixed to all filenames given.
- * @var string
- * @see HTML_Template_IT(), setRoot()
- * @access private
- */
- var $fileRoot = '';
- /**
- * Internal flag indicating that a blockname was used multiple times.
- * @var boolean
- * @access private
- */
- var $flagBlocktrouble = false;
- /**
- * Flag indicating that the global block was parsed.
- * @var boolean
- * @access private
- */
- var $flagGlobalParsed = false;
- /**
- * EXPERIMENTAL! FIXME!
- * Flag indication that a template gets cached.
- *
- * Complex templates require some times to be preparsed
- * before the replacement can take place. Often I use
- * one template file over and over again but I don't know
- * before that I will use the same template file again.
- * Now IT could notice this and skip the preparse.
- *
- * @var boolean
- * @access private
- */
- var $flagCacheTemplatefile = true;
- /**
- * EXPERIMENTAL! FIXME!
- * @access private
- */
- var $lastTemplatefile = '';
- /**
- * $_options['preserve_data'] Whether to substitute variables and remove
- * empty placeholders in data passed through setVariable
- * (see also bugs #20199, #21951).
- * $_options['use_preg'] Whether to use preg_replace instead of
- * str_replace in parse()
- * (this is a backwards compatibility feature, see also bugs #21951, #20392)
- *
- * @var array
- * @access private
- */
- var $_options = array(
- 'preserve_data' => false,
- 'use_preg' => true,
- 'preserve_input'=> true
- );
- /**
- * Builds some complex regular expressions and optinally sets the
- * file root directory.
- *
- * Make sure that you call this constructor if you derive your template
- * class from this one.
- *
- * @param string $root File root directory, prefix for all filenames
- * given to the object.
- * @param mixed $options Unknown
- *
- * @see setRoot()
- * @access public
- */
- function HTML_Template_IT($root = '', $options = null)
- {
- if (!is_null($options)) {
- $this->setOptions($options);
- }
- $this->variablesRegExp = '@' . $this->openingDelimiter .
- '(' . $this->variablenameRegExp . ')' .
- $this->closingDelimiter . '@sm';
- $this->removeVariablesRegExp = '@' . $this->openingDelimiter .
- "\s*(" . $this->variablenameRegExp .
- ")\s*" . $this->closingDelimiter .'@sm';
- $this->blockRegExp = '@<!--\s+BEGIN\s+(' . $this->blocknameRegExp .
- ')\s+-->(.*)<!--\s+END\s+\1\s+-->@sm';
- $this->setRoot($root);
- } // end constructor
- /**
- * Sets the option for the template class
- *
- * @param string $option option name
- * @param mixed $value option value
- *
- * @access public
- * @return mixed IT_OK on success, error object on failure
- */
- function setOption($option, $value)
- {
- if (array_key_exists($option, $this->_options)) {
- $this->_options[$option] = $value;
- return IT_OK;
- }
- return PEAR::raiseError(
- $this->errorMessage(IT_UNKNOWN_OPTION) . ": '{$option}'",
- IT_UNKNOWN_OPTION);
- }
- /**
- * Sets the options for the template class
- *
- * @param string[] $options options array of options
- * default value:
- * 'preserve_data' => false,
- * 'use_preg' => true
- *
- * @access public
- * @return mixed IT_OK on success, error object on failure
- * @see $options
- */
- function setOptions($options)
- {
- if (is_array($options)) {
- foreach ($options as $option => $value) {
- $error = $this->setOption($option, $value);
- if (PEAR::isError($error)) {
- return $error;
- }
- }
- }
- return IT_OK;
- }
- /**
- * Print a certain block with all replacements done.
- *
- * @param string $block block
- *
- * @brother get()
- * @access public
- * @return null
- */
- function show($block = '__global__')
- {
- print $this->get($block);
- } // end func show
- /**
- * Returns a block with all replacements done.
- *
- * @param string $block name of the block
- *
- * @return string
- * @throws PEAR_Error
- * @access public
- * @see show()
- */
- function get($block = '__global__')
- {
- if ($block == '__global__' && !$this->flagGlobalParsed) {
- $this->parse('__global__');
- }
- if (!isset($this->blocklist[$block])) {
- $this->err[] = PEAR::raiseError($this->errorMessage(IT_BLOCK_NOT_FOUND) .
- '"' . $block . "'",
- IT_BLOCK_NOT_FOUND);
- return '';
- }
- if (isset($this->blockdata[$block])) {
- $ret = $this->blockdata[$block];
- if ($this->clearCache) {
- unset($this->blockdata[$block]);
- if ($block == '__global__') {
- $this->flagGlobalParsed = false;
- }
- }
- if ($this->_options['preserve_data']) {
- $ret = str_replace($this->openingDelimiter .
- '%preserved%' . $this->closingDelimiter,
- $this->openingDelimiter,
- $ret);
- }
- return $ret;
- }
- return '';
- } // end func get()
- /**
- * Parses the given block.
- *
- * @param string $block name of the block to be parsed
- * @param bool $flag_recursion unknown
- *
- * @access public
- * @see parseCurrentBlock()
- * @throws PEAR_Error
- * @return null
- */
- function parse($block = '__global__', $flag_recursion = false)
- {
- static $regs, $values;
- if (!isset($this->blocklist[$block])) {
- return PEAR::raiseError($this->errorMessage(IT_BLOCK_NOT_FOUND)
- . '"' . $block . "'", IT_BLOCK_NOT_FOUND);
- }
- if ($block == '__global__') {
- $this->flagGlobalParsed = true;
- }
- if (!$flag_recursion) {
- $regs = array();
- $values = array();
- }
- $outer = $this->blocklist[$block];
- $empty = true;
- $variablelist = array();
- if ($this->clearCacheOnParse) {
- foreach ($this->variableCache as $name => $value) {
- $regs[] = $this->openingDelimiter .
- $name . $this->closingDelimiter;
- $values[] = $value;
- $empty = false;
- $variablelist[] = $name;
- }
- $this->variableCache = array();
- } else {
- foreach ($this->blockvariables[$block] as $allowedvar => $v) {
- if (isset($this->variableCache[$allowedvar])) {
- $regs[] = $this->openingDelimiter .
- $allowedvar . $this->closingDelimiter;
- $values[] = $this->variableCache[$allowedvar];
- unset($this->variableCache[$allowedvar]);
- $empty = false;
- $variablelist[] = $allowedvar;
- }
- }
- }
- if (isset($this->blockinner[$block])) {
- foreach ($this->blockinner[$block] as $k => $innerblock) {
- $this->parse($innerblock, true);
- if ($this->blockdata[$innerblock] != '') {
- $empty = false;
- }
- $placeholder = $this->openingDelimiter . "__" .
- $innerblock . "__" . $this->closingDelimiter;
- $outer = str_replace($placeholder,
- $this->blockdata[$innerblock], $outer);
- $this->blockdata[$innerblock] = "";
- }
- }
- if (!$flag_recursion && 0 != count($values)) {
- if ($this->_options['use_preg']) {
- $regs = array_map(array(&$this, '_addPregDelimiters'), $regs);
- $values = array_map(array(&$this, '_escapeBackreferences'), $values);
- $funcReplace = 'preg_replace';
- } else {
- $funcReplace = 'str_replace';
- }
- if ($this->_options['preserve_data']) {
- $values = array_map(array(&$this, '_preserveOpeningDelimiter'),
- $values);
- }
- $outer = $funcReplace($regs, $values, $outer);
- }
- if ($this->removeUnknownVariables) {
- $outer = $this->removeUnknownVariablesFromBlock($block,
- $outer,
- $variablelist);
- }
- if ($empty) {
- if (!$this->removeEmptyBlocks) {
- $this->blockdata[$block ] .= $outer;
- } else {
- if (isset($this->touchedBlocks[$block])) {
- $this->blockdata[$block] .= $outer;
- unset($this->touchedBlocks[$block]);
- }
- }
- } else {
- if (empty($this->blockdata[$block])) {
- $this->blockdata[$block] = $outer;
- } else {
- $this->blockdata[$block] .= $outer;
- }
- }
- return $empty;
- } // end func parse
- /**
- * Removes unknown variables from block. If preserve_input is set to true
- * only unknown variables that were present during setTemplate or
- * loadTemplatefile are removed. Thus you can set a variable to
- * "{SOMEINPUTDATA}" which is preserved.
- *
- * @param string $blockname block
- * @param string $blockinner unknown
- * @param string $variableList unknown
- *
- * @see parse()
- * @access private
- * @return null
- */
- function removeUnknownVariablesFromBlock ($blockname, $blockinner, $variableList)
- {
- if ($this->_options['preserve_input']) {
- foreach ($this->blockvariables[$blockname] as $var => $setted) {
- if (!in_array($var, $variableList)) {
- $blockinner = str_replace($this->openingDelimiter .
- $var . $this->closingDelimiter, '', $blockinner);
- }
- }
- } else {
- $blockinner = preg_replace($this->removeVariablesRegExp,
- '',
- $blockinner);
- }
- return $blockinner;
- }
- /**
- * Parses the current block
- *
- * @see parse(), setCurrentBlock(), $currentBlock
- * @access public
- * @return null
- */
- function parseCurrentBlock()
- {
- return $this->parse($this->currentBlock);
- } // end func parseCurrentBlock
- /**
- * Sets a variable value.
- *
- * The function can be used eighter like setVariable( "varname", "value")
- * or with one array $variables["varname"] = "value"
- * given setVariable($variables) quite like phplib templates set_var().
- *
- * @param mixed $variable string with the variable name or an array
- * %variables["varname"] = "value"
- * @param string $value value of the variable or empty if $variable
- * is an array.
- *
- * @access public
- * @return null
- */
- function setVariable($variable, $value = '')
- {
- if (is_array($variable)) {
- $this->variableCache = array_merge($this->variableCache, $variable);
- } else {
- $this->variableCache[$variable] = $value;
- }
- } // end func setVariable
- /**
- * Sets the name of the current block that is the block where variables
- * are added.
- *
- * @param string $block name of the block
- *
- * @return boolean false on failure, otherwise true
- * @throws PEAR_Error
- * @access public
- */
- function setCurrentBlock($block = '__global__')
- {
- if (!isset($this->blocklist[$block])) {
- return PEAR::raiseError($this->errorMessage(IT_BLOCK_NOT_FOUND)
- . '"' . $block . "'",
- IT_BLOCK_NOT_FOUND);
- }
- $this->currentBlock = $block;
- return true;
- } // end func setCurrentBlock
- /**
- * Preserves an empty block even if removeEmptyBlocks is true.
- *
- * @param string $block name of the block
- *
- * @return boolean false on false, otherwise true
- * @throws PEAR_Error
- * @access public
- * @see $removeEmptyBlocks
- */
- function touchBlock($block)
- {
- if (!isset($this->blocklist[$block])) {
- return PEAR::raiseError($this->errorMessage(IT_BLOCK_NOT_FOUND) .
- '"' . $block . "'", IT_BLOCK_NOT_FOUND);
- }
- $this->touchedBlocks[$block] = true;
- return true;
- } // end func touchBlock
- /**
- * Clears all datafields of the object and rebuild the internal blocklist
- *
- * LoadTemplatefile() and setTemplate() automatically call this function
- * when a new template is given. Don't use this function
- * unless you know what you're doing.
- *
- * @access private
- * @see free()
- * @return null
- */
- function init()
- {
- $this->free();
- $this->findBlocks($this->template);
- // we don't need it any more
- $this->template = '';
- $this->buildBlockvariablelist();
- } // end func init
- /**
- * Clears all datafields of the object.
- *
- * Don't use this function unless you know what you're doing.
- *
- * @access private
- * @see init()
- * @return null
- */
- function free()
- {
- $this->err = array();
- $this->currentBlock = '__global__';
- $this->variableCache = array();
- $this->blocklist = array();
- $this->touchedBlocks = array();
- $this->flagBlocktrouble = false;
- $this->flagGlobalParsed = false;
- } // end func free
- /**
- * Sets the template.
- *
- * You can eighter load a template file from disk with
- * LoadTemplatefile() or set the template manually using this function.
- *
- * @param string $template template content
- * @param bool $removeUnknownVariables how to handle unknown variables.
- * @param bool $removeEmptyBlocks how to handle empty blocks.
- *
- * @see LoadTemplatefile(), $template
- * @access public
- * @return boolean
- */
- function setTemplate( $template, $removeUnknownVariables = true,
- $removeEmptyBlocks = true)
- {
- $this->removeUnknownVariables = $removeUnknownVariables;
- $this->removeEmptyBlocks = $removeEmptyBlocks;
- if ($template == '' && $this->flagCacheTemplatefile) {
- $this->variableCache = array();
- $this->blockdata = array();
- $this->touchedBlocks = array();
- $this->currentBlock = '__global__';
- } else {
- $this->template = '<!-- BEGIN __global__ -->' . $template .
- '<!-- END __global__ -->';
- $this->init();
- }
- if ($this->flagBlocktrouble) {
- return false;
- }
- return true;
- } // end func setTemplate
- /**
- * Reads a template file from the disk.
- *
- * @param string $filename name of the template file
- * @param bool $removeUnknownVariables how to handle unknown variables.
- * @param bool $removeEmptyBlocks how to handle empty blocks.
- *
- * @access public
- * @return boolean false on failure, otherwise true
- * @see $template, setTemplate(), $removeUnknownVariables,
- * $removeEmptyBlocks
- */
- function loadTemplatefile( $filename,
- $removeUnknownVariables = true,
- $removeEmptyBlocks = true )
- {
- $template = '';
- if (!$this->flagCacheTemplatefile ||
- $this->lastTemplatefile != $filename
- ) {
- $template = $this->getFile($filename);
- }
- $this->lastTemplatefile = $filename;
- return $template != '' ?
- $this->setTemplate($template,
- $removeUnknownVariables,
- $removeEmptyBlocks) : false;
- } // end func LoadTemplatefile
- /**
- * Sets the file root. The file root gets prefixed to all filenames passed
- * to the object.
- *
- * Make sure that you override this function when using the class
- * on windows.
- *
- * @param string $root File root
- *
- * @see HTML_Template_IT()
- * @access public
- * @return null
- */
- function setRoot($root)
- {
- if ($root != '' && substr($root, -1) != '/') {
- $root .= '/';
- }
- $this->fileRoot = $root;
- } // end func setRoot
- /**
- * Build a list of all variables within of a block
- *
- * @access private
- * @return null
- */
- function buildBlockvariablelist()
- {
- foreach ($this->blocklist as $name => $content) {
- preg_match_all($this->variablesRegExp, $content, $regs);
- if (count($regs[1]) != 0) {
- foreach ($regs[1] as $k => $var) {
- $this->blockvariables[$name][$var] = true;
- }
- } else {
- $this->blockvariables[$name] = array();
- }
- }
- } // end func buildBlockvariablelist
- /**
- * Returns a list of all global variables
- *
- * @access public
- * @return array
- */
- function getGlobalvariables()
- {
- $regs = array();
- $values = array();
- foreach ($this->blockvariables['__global__'] as $allowedvar => $v) {
- if (isset($this->variableCache[$allowedvar])) {
- $regs[] = '@' . $this->openingDelimiter .
- $allowedvar . $this->closingDelimiter . '@';
- $values[] = $this->variableCache[$allowedvar];
- unset($this->variableCache[$allowedvar]);
- }
- }
- return array($regs, $values);
- } // end func getGlobalvariables
- /**
- * Recusively builds a list of all blocks within the template.
- *
- * @param string $string string that gets scanned
- *
- * @access private
- * @see $blocklist
- * @return array
- */
- function findBlocks($string)
- {
- $blocklist = array();
- if (preg_match_all($this->blockRegExp, $string, $regs, PREG_SET_ORDER)) {
- foreach ($regs as $k => $match) {
- $blockname = $match[1];
- $blockcontent = $match[2];
- if (isset($this->blocklist[$blockname])) {
- $msg = $this->errorMessage(IT_BLOCK_DUPLICATE, $blockname);
- $this->err[] = PEAR::raiseError($msg, IT_BLOCK_DUPLICATE);
- $this->flagBlocktrouble = true;
- }
- $this->blocklist[$blockname] = $blockcontent;
- $this->blockdata[$blockname] = "";
- $blocklist[] = $blockname;
- $inner = $this->findBlocks($blockcontent);
- $regex = '@<!--\s+BEGIN\s+%s\s+-->(.*)<!--\s+END\s+%s\s+-->@sm';
- foreach ($inner as $k => $name) {
- $pattern = sprintf($regex, preg_quote($name), preg_quote($name));
- $this->blocklist[$blockname] = preg_replace($pattern,
- $this->openingDelimiter .
- '__' . $name . '__' .
- $this->closingDelimiter,
- $this->blocklist[$blockname]);
- $this->blockinner[$blockname][] = $name;
- $this->blockparents[$name] = $blockname;
- }
- }
- }
- return $blocklist;
- } // end func findBlocks
- /**
- * Reads a file from disk and returns its content.
- *
- * @param string $filename Filename
- *
- * @return string Filecontent
- * @access private
- */
- function getFile($filename)
- {
- if ($filename{0} == '/' && substr($this->fileRoot, -1) == '/') {
- $filename = substr($filename, 1);
- }
- $filename = $this->fileRoot . $filename;
- if (!($fh = @fopen($filename, 'r'))) {
- $this->err[] = PEAR::raiseError($this->errorMessage(IT_TPL_NOT_FOUND) .
- ': "' .$filename .'"',
- IT_TPL_NOT_FOUND);
- return "";
- }
- $fsize = filesize($filename);
- if ($fsize < 1) {
- fclose($fh);
- return '';
- }
- $content = fread($fh, $fsize);
- fclose($fh);
- return preg_replace("#<!-- INCLUDE (.*) -->#ime",
- "\$this->getFile('\\1')",
- $content);
- } // end func getFile
- /**
- * Adds delimiters to a string, so it can be used as a pattern
- * in preg_* functions
- *
- * @param string $str input
- *
- * @return string
- * @access private
- */
- function _addPregDelimiters($str)
- {
- return '@' . preg_quote($str) . '@';
- }
- /**
- * Escapes $ and \ as preg_replace will treat
- * them as a backreference and not literal.
- * See bug #9501
- *
- * @param string $str String to escape
- *
- * @since 1.2.2
- * @return string
- * @access private
- */
- function _escapeBackreferences($str)
- {
- $str = str_replace('\\', '\\\\', $str);
- $str = preg_replace('@\$([0-9]{1,2})@', '\\\$${1}', $str);
- return $str;
- }
- /**
- * Replaces an opening delimiter by a special string
- *
- * @param string $str special string
- *
- * @return string
- * @access private
- */
- function _preserveOpeningDelimiter($str)
- {
- return (false === strpos($str, $this->openingDelimiter))?
- $str:
- str_replace($this->openingDelimiter,
- $this->openingDelimiter .
- '%preserved%' . $this->closingDelimiter,
- $str);
- }
- /**
- * Return a textual error message for a IT error code
- *
- * @param integer $value error code
- * @param string $blockname unknown
- *
- * @access private
- * @return string error message, or false if the error code was
- * not recognized
- */
- function errorMessage($value, $blockname = '')
- {
- static $errorMessages;
- if (!isset($errorMessages)) {
- $errorMessages = array(
- IT_OK => '',
- IT_ERROR => 'unknown error',
- IT_TPL_NOT_FOUND => 'Cannot read the template file',
- IT_BLOCK_NOT_FOUND => 'Cannot find this block',
- IT_BLOCK_DUPLICATE => 'The name of a block must be'.
- ' uniquewithin a template.'.
- ' Found "' . $blockname . '" twice.'.
- 'Unpredictable results '.
- 'may appear.',
- IT_UNKNOWN_OPTION => 'Unknown option'
- );
- }
- if (PEAR::isError($value)) {
- $value = $value->getCode();
- }
- return isset($errorMessages[$value]) ?
- $errorMessages[$value] : $errorMessages[IT_ERROR];
- }
- } // end class IntegratedTemplate
- ?>