aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/includes/classes/template.php
diff options
context:
space:
mode:
Diffstat (limited to 'phpBB/includes/classes/template.php')
-rw-r--r--phpBB/includes/classes/template.php531
1 files changed, 0 insertions, 531 deletions
diff --git a/phpBB/includes/classes/template.php b/phpBB/includes/classes/template.php
deleted file mode 100644
index 1ef29545d2..0000000000
--- a/phpBB/includes/classes/template.php
+++ /dev/null
@@ -1,531 +0,0 @@
-<?php
-/**
-*
-* @package phpBB3
-* @version $Id$
-* @copyright (c) 2005 phpBB Group, sections (c) 2001 ispi of Lincoln Inc
-* @license http://opensource.org/licenses/gpl-license.php GNU Public License
-*
-*/
-
-/**
-* @ignore
-*/
-if (!defined('IN_PHPBB'))
-{
- exit;
-}
-
-/**
-* @todo
-* IMG_ for image substitution?
-* {IMG_[key]:[alt]:[type]}
-* {IMG_ICON_CONTACT:CONTACT:full} -> phpbb::$user->img('icon_contact', 'CONTACT', 'full');
-*
-* More in-depth...
-* yadayada
-*/
-
-/**
-* Base Template class.
-* @package phpBB3
-*/
-class phpbb_template
-{
- public $phpbb_required = array('user', 'config');
- public $phpbb_optional = array();
-
- /**
- * variable that holds all the data we'll be substituting into
- * the compiled templates. Takes form:
- * --> $this->_tpldata[block][iteration#][child][iteration#][child2][iteration#][variablename] == value
- * if it's a root-level variable, it'll be like this:
- * --> $this->_tpldata[.][0][varname] == value
- * @var array
- */
- private $_tpldata = array('.' => array(0 => array()));
-
- /**
- * @var array Reference to template->_tpldata['.'][0]
- */
- private $_rootref;
-
- /**
- * @var string Root dir for template.
- */
- private $root = '';
-
- /**
- * @var string Path of the cache directory for the template
- */
- public $cachepath = '';
-
- /**
- * @var array Hash of handle => file path pairs
- */
- public $files = array();
-
- /**
- * @var array Hash of handle => filename pairs
- */
- public $filename = array();
-
- /**
- * Set template location
- * @access public
- */
- public function set_template()
- {
- if (file_exists(PHPBB_ROOT_PATH . 'styles/' . phpbb::$user->theme['template_path'] . '/template'))
- {
- $this->root = PHPBB_ROOT_PATH . 'styles/' . phpbb::$user->theme['template_path'] . '/template';
- $this->cachepath = PHPBB_ROOT_PATH . 'cache/tpl_' . phpbb::$user->theme['template_path'] . '_';
- }
- else
- {
- trigger_error('Template path could not be found: styles/' . phpbb::$user->theme['template_path'] . '/template', E_USER_ERROR);
- }
-
- $this->_rootref = &$this->_tpldata['.'][0];
- }
-
- /**
- * Set custom template location (able to use directory outside of phpBB)
- * @access public
- * @param string $template_path Path to template directory
- * @param string $template_name Name of template
- */
- public function set_custom_template($template_path, $template_name)
- {
- $this->root = $template_path;
- $this->cachepath = PHPBB_ROOT_PATH . 'cache/ctpl_' . str_replace('_', '-', $template_name) . '_';
- }
-
- /**
- * Sets the template filenames for handles. $filename_array
- * @access public
- * @param array $filname_array Should be a hash of handle => filename pairs.
- */
- public function set_filenames(array $filename_array)
- {
- foreach ($filename_array as $handle => $filename)
- {
- if (empty($filename))
- {
- trigger_error("template->set_filenames: Empty filename specified for $handle", E_USER_ERROR);
- }
-
- $this->filename[$handle] = $filename;
- $this->files[$handle] = $this->root . '/' . $filename;
- }
-
- return true;
- }
-
- /**
- * Destroy template data set
- * @access public
- */
- public function __destruct()
- {
- $this->_tpldata = array('.' => array(0 => array()));
- }
-
- /**
- * Reset/empty complete block
- * @access public
- * @param string $blockname Name of block to destroy
- */
- public function destroy_block_vars($blockname)
- {
- if (strpos($blockname, '.') !== false)
- {
- // Nested block.
- $blocks = explode('.', $blockname);
- $blockcount = sizeof($blocks) - 1;
-
- $str = &$this->_tpldata;
- for ($i = 0; $i < $blockcount; $i++)
- {
- $str = &$str[$blocks[$i]];
- $str = &$str[sizeof($str) - 1];
- }
-
- unset($str[$blocks[$blockcount]]);
- }
- else
- {
- // Top-level block.
- unset($this->_tpldata[$blockname]);
- }
- }
-
- /**
- * Display handle
- * @access public
- * @param string $handle Handle to display
- * @param bool $include_once Allow multiple inclusions
- * @return bool True on success, false on failure
- */
- public function display($handle, $include_once = true)
- {
-/*
- if (!empty($phpbb_hook) && $phpbb_hook->call_hook(array(__CLASS__, __FUNCTION__), $handle, $include_once))
- {
- if ($phpbb_hook->hook_return(array(__CLASS__, __FUNCTION__)))
- {
- return $phpbb_hook->hook_return_result(array(__CLASS__, __FUNCTION__));
- }
- }
-*/
-/* if (defined('IN_ERROR_HANDLER'))
- {
- if ((E_NOTICE & error_reporting()) == E_NOTICE)
- {
- //error_reporting(error_reporting() ^ E_NOTICE);
- }
- }*/
-
- $_tpldata = &$this->_tpldata;
- $_rootref = &$this->_rootref;
- $_lang = &phpbb::$user->lang;
-
- if (($filename = $this->_tpl_load($handle)) !== false)
- {
- ($include_once) ? include_once($filename) : include($filename);
- }
- else if (($code = $this->_tpl_eval($handle)) !== false)
- {
- $code = ' ?> ' . $code . ' <?php ';
- eval($code);
- }
- else
- {
- // if we could not eval AND the file exists, something horrific has occured
- return false;
- }
-
- return true;
- }
-
- /**
- * Display the handle and assign the output to a template variable or return the compiled result.
- * @access public
- * @param string $handle Handle to operate on
- * @param string $template_var Template variable to assign compiled handle to
- * @param bool $return_content If true return compiled handle, otherwise assign to $template_var
- * @param bool $include_once Allow multiple inclusions of the file
- * @return bool|string If $return_content is true return string of the compiled handle, otherwise return true
- */
- public function assign_display($handle, $template_var = '', $return_content = true, $include_once = false)
- {
- ob_start();
- $this->display($handle, $include_once);
- $contents = ob_get_clean();
-
- if ($return_content)
- {
- return $contents;
- }
-
- $this->assign_var($template_var, $contents);
-
- return true;
- }
-
- /**
- * Load a compiled template if possible, if not, recompile it
- * @access private
- * @param string $handle Handle of the template to load
- * @return string|bool Return filename on success otherwise false
- * @uses template_compile is used to compile uncached templates
- */
- private function _tpl_load($handle)
- {
- if (!isset($this->filename[$handle]))
- {
- trigger_error("template->_tpl_load(): No file specified for handle $handle", E_USER_ERROR);
- }
-
- $filename = $this->cachepath . str_replace('/', '.', $this->filename[$handle]) . '.' . PHP_EXT;
-
- $recompile = (!file_exists($filename) || @filesize($filename) === 0 || (phpbb::$config['load_tplcompile'] && @filemtime($filename) < filemtime($this->files[$handle]))) ? true : false;
-
- if (phpbb::$base_config['debug_extra'])
- {
- $recompile = true;
- }
-
- // Recompile page if the original template is newer, otherwise load the compiled version
- if ($recompile)
- {
- $compile = new phpbb_template_compile($this);
-
- // If we don't have a file assigned to this handle, die.
- if (!isset($this->files[$handle]))
- {
- trigger_error("template->_tpl_load(): No file specified for handle $handle", E_USER_ERROR);
- }
-
- if ($compile->_tpl_load_file($handle) === false)
- {
- return false;
- }
- }
-
- return $filename;
- }
-
- /**
- * This code should only run when some high level error prevents us from writing to the cache.
- * @access private
- * @param string $handle Template handle to compile
- * @return string|bool Return compiled code on success otherwise false
- * @uses template_compile is used to compile template
- */
- private function _tpl_eval($handle)
- {
- $compile = new phpbb_template_compile($this);
-
- // If we don't have a file assigned to this handle, die.
- if (!isset($this->files[$handle]))
- {
- trigger_error("template->_tpl_eval(): No file specified for handle $handle", E_USER_ERROR);
- }
-
- if (($code = $compile->_tpl_gen_src($handle)) === false)
- {
- return false;
- }
-
- return $code;
- }
-
- /**
- * Assign key variable pairs from an array
- * @access public
- * @param array $vararray A hash of variable name => value pairs
- */
- public function assign_vars(array $vararray)
- {
- foreach ($vararray as $key => $val)
- {
- $this->_rootref[$key] = $val;
- }
- }
-
- /**
- * Assign a single variable to a single key
- * @access public
- * @param string $varname Variable name
- * @param string $varval Value to assign to variable
- */
- public function assign_var($varname, $varval)
- {
- $this->_rootref[$varname] = $varval;
- }
-
- /**
- * Assign key variable pairs from an array to a specified block
- * @access public
- * @param string $blockname Name of block to assign $vararray to
- * @param array $vararray A hash of variable name => value pairs
- */
- public function assign_block_vars($blockname, array $vararray)
- {
- if (strpos($blockname, '.') !== false)
- {
- // Nested block.
- $blocks = explode('.', $blockname);
- $blockcount = sizeof($blocks) - 1;
-
- $str = &$this->_tpldata;
- for ($i = 0; $i < $blockcount; $i++)
- {
- $str = &$str[$blocks[$i]];
- $str = &$str[sizeof($str) - 1];
- }
-
- // Now we add the block that we're actually assigning to.
- // We're adding a new iteration to this block with the given
- // variable assignments.
- $str[$blocks[$blockcount]][] = $vararray;
- }
- else
- {
- // Top-level block.
-
- // Add a new iteration to this block with the variable assignments we were given.
- $this->_tpldata[$blockname][] = $vararray;
- }
- }
-
- /**
- * Change already assigned key variable pair (one-dimensional - single loop entry)
- *
- * An example of how to use this function:
- *
- * @param string $blockname the blockname, for example 'loop'
- * @param array $vararray the var array to insert/add or merge
- * @param mixed $key Key to search for
- *
- * array: KEY => VALUE [the key/value pair to search for within the loop to determine the correct position]
- *
- * int: Position [the position to change or insert at directly given]
- *
- * If key is false the position is set to 0
- * If key is true the position is set to the last entry
- *
- * @param string $mode Mode to execute (valid modes are 'insert' and 'change')
- *
- * If insert, the vararray is inserted at the given position (position counting from zero).
- * If change, the current block gets merged with the vararray (resulting in new key/value pairs be added and existing keys be replaced by the new value).
- *
- * Since counting begins by zero, inserting at the last position will result in this array: array(vararray, last positioned array)
- * and inserting at position 1 will result in this array: array(first positioned array, vararray, following vars)
- *
- * @return bool false on error, true on success
- * @access public
- */
- public function alter_block_array($blockname, array $vararray, $key = false, $mode = 'insert')
- {
- if (strpos($blockname, '.') !== false)
- {
- // Nested block.
- $blocks = explode('.', $blockname);
- $blockcount = sizeof($blocks) - 1;
-
- $block = &$this->_tpldata;
- for ($i = 0; $i < $blockcount; $i++)
- {
- if (($pos = strpos($blocks[$i], '[')) !== false)
- {
- $name = substr($blocks[$i], 0, $pos);
-
- if (strpos($blocks[$i], '[]') === $pos)
- {
- $index = sizeof($block[$name]) - 1;
- }
- else
- {
- $index = min((int) substr($blocks[$i], $pos + 1, -1), sizeof($block[$name]) - 1);
- }
- }
- else
- {
- $name = $blocks[$i];
- $index = sizeof($block[$name]) - 1;
- }
- $block = &$block[$name];
- $block = &$block[$index];
- }
-
- $block = &$block[$blocks[$i]]; // Traverse the last block
- }
- else
- {
- // Top-level block.
- $block = &$this->_tpldata[$blockname];
- }
-
- // Change key to zero (change first position) if false and to last position if true
- if ($key === false || $key === true)
- {
- $key = ($key === false) ? 0 : sizeof($block);
- }
-
- // Get correct position if array given
- if (is_array($key))
- {
- // Search array to get correct position
- list($search_key, $search_value) = @each($key);
-
- $key = NULL;
- foreach ($block as $i => $val_ary)
- {
- if ($val_ary[$search_key] === $search_value)
- {
- $key = $i;
- break;
- }
- }
-
- // key/value pair not found
- if ($key === NULL)
- {
- return false;
- }
- }
-
- // Insert Block
- if ($mode == 'insert')
- {
- // Re-position template blocks
- for ($i = sizeof($block); $i > $key; $i--)
- {
- $block[$i] = $block[$i-1];
- }
-
- // Insert vararray at given position
- $block[$key] = $vararray;
-
- return true;
- }
-
- // Which block to change?
- if ($mode == 'change')
- {
- if ($key == sizeof($block))
- {
- $key--;
- }
-
- $block[$key] = array_merge($block[$key], $vararray);
-
- return true;
- }
-
- return false;
- }
-
- /**
- * Include a separate template
- * @access private
- * @param string $filename Template filename to include
- * @param bool $include True to include the file, false to just load it
- * @uses template_compile is used to compile uncached templates
- */
- private function _tpl_include($filename, $include = true)
- {
- $handle = $filename;
- $this->filename[$handle] = $filename;
- $this->files[$handle] = $this->root . '/' . $filename;
-
- $filename = $this->_tpl_load($handle);
-
- if ($include)
- {
- $_tpldata = &$this->_tpldata;
- $_rootref = &$this->_rootref;
- $_lang = &phpbb::$user->lang;
-
- if ($filename)
- {
- include($filename);
- return;
- }
- else
- {
- $compile = new phpbb_template_compile($this);
-
- if (($code = $compile->_tpl_gen_src($handle)) !== false)
- {
- $code = ' ?> ' . $code . ' <?php ';
- eval($code);
- }
- }
- }
- }
-}
-
-?> \ No newline at end of file