mirror of
https://github.com/phpbb/phpbb.git
synced 2025-07-31 14:00:31 +02:00
Merge branch 'develop' of github.com:phpbb/phpbb3 into ticket/11816
# By David King (16) and others # Via David King (13) and others * 'develop' of github.com:phpbb/phpbb3: (67 commits) [ticket/11825] Move schema_data.php into includes/ instead of phpbb/ [ticket/11215] Remove unnecessary comment [ticket/11755] MySQL upgrader out of date [prep-release-3.0.12] Update Changelog for 3.0.12-RC3 release. [prep-release-3.0.12] Bumping version number for 3.0.12-RC3. [ticket/11823] Set up nginx server to match PHP files with characters after .php [ticket/11812] Fix empty define [ticket/11818] Update Symfony dependencies to 2.3.* [ticket/11791] Load adm/ events from styles/adm/event/ [ticket/11215] Fix helper_url_test.php tests [ticket/11215] Add newline back to .htaccess, fix wording [ticket/11215] Update comment in .htaccess [ticket/11215] Uncomment rewrite rules in .htaccess [ticket/11215] Make controller helper url() method use correct format [ticket/11215] Add commented-out URL rewrite capability to .htaccess [ticket/11821] Fix comma usage next to "You are receiving this notification". [ticket/11769] Allow using 0 as poster name [ticket/11769] Allow '0' as username [ticket/11215] Use new URL structure for controllers [ticket/11215] Everything appears to be working... ... Conflicts: phpBB/phpbb/template/twig/lexer.php tests/template/template_test.php
This commit is contained in:
148
phpBB/phpbb/template/base.php
Normal file
148
phpBB/phpbb/template/base.php
Normal file
@@ -0,0 +1,148 @@
|
||||
<?php
|
||||
/**
|
||||
*
|
||||
* @package phpBB3
|
||||
* @copyright (c) 2013 phpBB Group
|
||||
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ignore
|
||||
*/
|
||||
if (!defined('IN_PHPBB'))
|
||||
{
|
||||
exit;
|
||||
}
|
||||
|
||||
abstract class phpbb_template_base implements phpbb_template
|
||||
{
|
||||
/**
|
||||
* Template context.
|
||||
* Stores template data used during template rendering.
|
||||
*
|
||||
* @var phpbb_template_context
|
||||
*/
|
||||
protected $context;
|
||||
|
||||
/**
|
||||
* Array of filenames assigned to set_filenames
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $filenames = array();
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function set_filenames(array $filename_array)
|
||||
{
|
||||
$this->filenames = array_merge($this->filenames, $filename_array);
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a filename from the handle
|
||||
*
|
||||
* @param string $handle
|
||||
* @return string
|
||||
*/
|
||||
protected function get_filename_from_handle($handle)
|
||||
{
|
||||
return (isset($this->filenames[$handle])) ? $this->filenames[$handle] : $handle;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function destroy()
|
||||
{
|
||||
$this->context->clear();
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function destroy_block_vars($blockname)
|
||||
{
|
||||
$this->context->destroy_block_vars($blockname);
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function assign_vars(array $vararray)
|
||||
{
|
||||
foreach ($vararray as $key => $val)
|
||||
{
|
||||
$this->assign_var($key, $val);
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function assign_var($varname, $varval)
|
||||
{
|
||||
$this->context->assign_var($varname, $varval);
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function append_var($varname, $varval)
|
||||
{
|
||||
$this->context->append_var($varname, $varval);
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function assign_block_vars($blockname, array $vararray)
|
||||
{
|
||||
$this->context->assign_block_vars($blockname, $vararray);
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function alter_block_array($blockname, array $vararray, $key = false, $mode = 'insert')
|
||||
{
|
||||
return $this->context->alter_block_array($blockname, $vararray, $key, $mode);
|
||||
}
|
||||
|
||||
/**
|
||||
* Calls hook if any is defined.
|
||||
*
|
||||
* @param string $handle Template handle being displayed.
|
||||
* @param string $method Method name of the caller.
|
||||
*/
|
||||
protected function call_hook($handle, $method)
|
||||
{
|
||||
global $phpbb_hook;
|
||||
|
||||
if (!empty($phpbb_hook) && $phpbb_hook->call_hook(array(__CLASS__, $method), $handle, $this))
|
||||
{
|
||||
if ($phpbb_hook->hook_return(array(__CLASS__, $method)))
|
||||
{
|
||||
$result = $phpbb_hook->hook_return_result(array(__CLASS__, $method));
|
||||
return array($result);
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
}
|
@@ -1,163 +0,0 @@
|
||||
<?php
|
||||
/**
|
||||
*
|
||||
* @package phpBB3
|
||||
* @copyright (c) 2011 phpBB Group
|
||||
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ignore
|
||||
*/
|
||||
if (!defined('IN_PHPBB'))
|
||||
{
|
||||
exit;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Resource locator interface.
|
||||
*
|
||||
* Objects implementing this interface maintain mapping from template handles
|
||||
* to source template file paths and locate templates.
|
||||
*
|
||||
* Locates style files.
|
||||
*
|
||||
* Resource locator is aware of styles tree, and can return actual
|
||||
* filesystem paths (i.e., the "child" style or the "parent" styles)
|
||||
* depending on what files exist.
|
||||
*
|
||||
* Root paths stored in locator are paths to style directories. Templates are
|
||||
* stored in subdirectory that $template_path points to.
|
||||
*
|
||||
* @package phpBB3
|
||||
*/
|
||||
interface phpbb_template_locator
|
||||
{
|
||||
/**
|
||||
* Sets the template filenames for handles. $filename_array
|
||||
* should be a hash of handle => filename pairs.
|
||||
*
|
||||
* @param array $filename_array Should be a hash of handle => filename pairs.
|
||||
*/
|
||||
public function set_filenames(array $filename_array);
|
||||
|
||||
/**
|
||||
* Determines the filename for a template handle.
|
||||
*
|
||||
* The filename comes from array used in a set_filenames call,
|
||||
* which should have been performed prior to invoking this function.
|
||||
* Return value is a file basename (without path).
|
||||
*
|
||||
* @param $handle string Template handle
|
||||
* @return string Filename corresponding to the template handle
|
||||
*/
|
||||
public function get_filename_for_handle($handle);
|
||||
|
||||
/**
|
||||
* Determines the source file path for a template handle without
|
||||
* regard for styles tree.
|
||||
*
|
||||
* This function returns the path in "primary" style directory
|
||||
* corresponding to the given template handle. That path may or
|
||||
* may not actually exist on the filesystem. Because this function
|
||||
* does not perform stat calls to determine whether the path it
|
||||
* returns actually exists, it is faster than get_source_file_for_handle.
|
||||
*
|
||||
* Use get_source_file_for_handle to obtain the actual path that is
|
||||
* guaranteed to exist (which might come from the parent style
|
||||
* directory if primary style has parent styles).
|
||||
*
|
||||
* This function will trigger an error if the handle was never
|
||||
* associated with a template file via set_filenames.
|
||||
*
|
||||
* @param $handle string Template handle
|
||||
* @return string Path to source file path in primary style directory
|
||||
*/
|
||||
public function get_virtual_source_file_for_handle($handle);
|
||||
|
||||
/**
|
||||
* Determines the source file path for a template handle, accounting
|
||||
* for styles tree and verifying that the path exists.
|
||||
*
|
||||
* This function returns the actual path that may be compiled for
|
||||
* the specified template handle. It will trigger an error if
|
||||
* the template handle was never associated with a template path
|
||||
* via set_filenames or if the template file does not exist on the
|
||||
* filesystem.
|
||||
*
|
||||
* Use get_virtual_source_file_for_handle to just resolve a template
|
||||
* handle to a path without any filesystem or styles tree checks.
|
||||
*
|
||||
* @param string $handle Template handle (i.e. "friendly" template name)
|
||||
* @param bool $find_all If true, each root path will be checked and function
|
||||
* will return array of files instead of string and will not
|
||||
* trigger a error if template does not exist
|
||||
* @return string Source file path
|
||||
*/
|
||||
public function get_source_file_for_handle($handle, $find_all = false);
|
||||
|
||||
/**
|
||||
* Obtains a complete filesystem path for a file in a style.
|
||||
*
|
||||
* This function traverses the style tree (selected style and
|
||||
* its parents in order, if inheritance is being used) and finds
|
||||
* the first file on the filesystem matching specified relative path,
|
||||
* or the first of the specified paths if more than one path is given.
|
||||
*
|
||||
* This function can be used to determine filesystem path of any
|
||||
* file under any style, with the consequence being that complete
|
||||
* relative to the style directory path must be provided as an argument.
|
||||
*
|
||||
* In particular, this function can be used to locate templates
|
||||
* and javascript files.
|
||||
*
|
||||
* For locating templates get_first_template_location should be used
|
||||
* as it prepends the configured template path to the template basename.
|
||||
*
|
||||
* Note: "selected style" is whatever style the style resource locator
|
||||
* is configured for.
|
||||
*
|
||||
* The return value then will be a path, relative to the current
|
||||
* directory or absolute, to the first existing file in the selected
|
||||
* style or its closest parent.
|
||||
*
|
||||
* If the selected style does not have the file being searched,
|
||||
* (and if inheritance is involved, none of the parents have it either),
|
||||
* false will be returned.
|
||||
*
|
||||
* Multiple files can be specified, in which case the first file in
|
||||
* the list that can be found on the filesystem is returned.
|
||||
*
|
||||
* If multiple files are specified and inheritance is involved,
|
||||
* first each of the specified files is checked in the selected style,
|
||||
* then each of the specified files is checked in the immediate parent,
|
||||
* etc.
|
||||
*
|
||||
* Specifying true for $return_default will cause the function to
|
||||
* return the first path which was checked for existence in the event
|
||||
* that the template file was not found, instead of false.
|
||||
* This is always a path in the selected style itself, not any of its
|
||||
* parents.
|
||||
*
|
||||
* If $return_full_path is false, then instead of returning a usable
|
||||
* path (when the file is found) the file's path relative to the style
|
||||
* directory will be returned. This is the same path as was given to
|
||||
* the function as a parameter. This can be used to check which of the
|
||||
* files specified in $files exists. Naturally this requires passing
|
||||
* more than one file in $files.
|
||||
*
|
||||
* @param array $files List of files to locate.
|
||||
* @param bool $return_default Determines what to return if file does not
|
||||
* exist. If true, function will return location where file is
|
||||
* supposed to be. If false, function will return false.
|
||||
* @param bool $return_full_path If true, function will return full path
|
||||
* to file. If false, function will return file name. This
|
||||
* parameter can be used to check which one of set of files
|
||||
* is available.
|
||||
* @return string or boolean Source file path if file exists or $return_default is
|
||||
* true. False if file does not exist and $return_default is false
|
||||
*/
|
||||
public function get_first_file_location($files, $return_default = false, $return_full_path = true);
|
||||
}
|
@@ -34,14 +34,32 @@ interface phpbb_template
|
||||
public function set_filenames(array $filename_array);
|
||||
|
||||
/**
|
||||
* Sets the style names/paths corresponding to style hierarchy being compiled
|
||||
* and/or rendered.
|
||||
* Get the style tree of the style preferred by the current user
|
||||
*
|
||||
* @param array $style_names List of style names in inheritance tree order
|
||||
* @param array $style_paths List of style paths in inheritance tree order
|
||||
* @return array Style tree, most specific first
|
||||
*/
|
||||
public function get_user_style();
|
||||
|
||||
/**
|
||||
* Set style location based on (current) user's chosen style.
|
||||
*
|
||||
* @param array $style_directories The directories to add style paths for
|
||||
* E.g. array('ext/foo/bar/styles', 'styles')
|
||||
* Default: array('styles') (phpBB's style directory)
|
||||
* @return phpbb_template $this
|
||||
*/
|
||||
public function set_style_names(array $style_names, array $style_paths);
|
||||
public function set_style($style_directories = array('styles'));
|
||||
|
||||
/**
|
||||
* Set custom style location (able to use directory outside of phpBB).
|
||||
*
|
||||
* Note: Templates are still compiled to phpBB's cache directory.
|
||||
*
|
||||
* @param string|array $names Array of names or string of name of template(s) in inheritance tree order, used by extensions.
|
||||
* @param string|array or string $paths Array of style paths, relative to current root directory
|
||||
* @return phpbb_template $this
|
||||
*/
|
||||
public function set_custom_style($names, $paths);
|
||||
|
||||
/**
|
||||
* Clears all variables and blocks assigned to this template.
|
||||
|
@@ -130,7 +130,7 @@ class phpbb_template_twig_lexer extends Twig_Lexer
|
||||
// E.g. 'asdf'"' -> asdf'"
|
||||
// E.g. "asdf'"" -> asdf'"
|
||||
// E.g. 'asdf'" -> 'asdf'"
|
||||
$matches[2] = preg_replace('#^([\'"])?(.+?)\1$#', '$2', $matches[2]);
|
||||
$matches[2] = preg_replace('#^([\'"])?(.*?)\1$#', '$2', $matches[2]);
|
||||
|
||||
// Replace template variables with start/end to parse variables (' ~ TEST ~ '.html)
|
||||
$matches[2] = preg_replace('#{([a-zA-Z0-9_\.$]+)}#', "'~ \$1 ~'", $matches[2]);
|
||||
@@ -219,6 +219,12 @@ class phpbb_template_twig_lexer extends Twig_Lexer
|
||||
*/
|
||||
protected function fix_if_tokens($code)
|
||||
{
|
||||
// Replace ELSE IF with ELSEIF
|
||||
$code = preg_replace('#<!-- ELSE IF (.+?) -->#', '<!-- ELSEIF $1 -->', $code);
|
||||
|
||||
// Replace our "div by" with Twig's divisibleby (Twig does not like test names with spaces)
|
||||
$code = preg_replace('# div by ([0-9]+)#', ' divisibleby($1)', $code);
|
||||
|
||||
$callback = function($matches)
|
||||
{
|
||||
$inner = $matches[2];
|
||||
@@ -234,9 +240,6 @@ class phpbb_template_twig_lexer extends Twig_Lexer
|
||||
return "<!-- {$matches[1]}IF{$inner}-->";
|
||||
};
|
||||
|
||||
// Replace our "div by" with Twig's divisibleby (Twig does not like test names with spaces)
|
||||
$code = preg_replace('# div by ([0-9]+)#', ' divisibleby($1)', $code);
|
||||
|
||||
return preg_replace_callback('#<!-- (ELSE)?IF((.*) \(?!?[\$|\.]([^\s]+)(.*))-->#', $callback, $code);
|
||||
}
|
||||
|
||||
|
@@ -19,15 +19,8 @@ if (!defined('IN_PHPBB'))
|
||||
* Twig Template class.
|
||||
* @package phpBB3
|
||||
*/
|
||||
class phpbb_template_twig implements phpbb_template
|
||||
class phpbb_template_twig extends phpbb_template_base
|
||||
{
|
||||
/**
|
||||
* Template context.
|
||||
* Stores template data used during template rendering.
|
||||
* @var phpbb_template_context
|
||||
*/
|
||||
protected $context;
|
||||
|
||||
/**
|
||||
* Path of the cache directory for the template
|
||||
*
|
||||
@@ -43,12 +36,6 @@ class phpbb_template_twig implements phpbb_template
|
||||
*/
|
||||
protected $phpbb_root_path;
|
||||
|
||||
/**
|
||||
* adm relative path
|
||||
* @var string
|
||||
*/
|
||||
protected $adm_relative_path;
|
||||
|
||||
/**
|
||||
* PHP file extension
|
||||
* @var string
|
||||
@@ -74,16 +61,6 @@ class phpbb_template_twig implements phpbb_template
|
||||
*/
|
||||
protected $extension_manager;
|
||||
|
||||
/**
|
||||
* Name of the style that the template being compiled and/or rendered
|
||||
* belongs to, and its parents, in inheritance tree order.
|
||||
*
|
||||
* Used to invoke style-specific template events.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $style_names;
|
||||
|
||||
/**
|
||||
* Twig Environment
|
||||
*
|
||||
@@ -91,13 +68,6 @@ class phpbb_template_twig implements phpbb_template
|
||||
*/
|
||||
protected $twig;
|
||||
|
||||
/**
|
||||
* Array of filenames assigned to set_filenames
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $filenames = array();
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
@@ -112,7 +82,6 @@ class phpbb_template_twig implements phpbb_template
|
||||
public function __construct($phpbb_root_path, $php_ext, $config, $user, phpbb_template_context $context, phpbb_extension_manager $extension_manager = null, $adm_relative_path = null)
|
||||
{
|
||||
$this->phpbb_root_path = $phpbb_root_path;
|
||||
$this->adm_relative_path = $adm_relative_path;
|
||||
$this->php_ext = $php_ext;
|
||||
$this->config = $config;
|
||||
$this->user = $user;
|
||||
@@ -147,6 +116,12 @@ class phpbb_template_twig implements phpbb_template
|
||||
$lexer = new phpbb_template_twig_lexer($this->twig);
|
||||
|
||||
$this->twig->setLexer($lexer);
|
||||
|
||||
// Add admin namespace
|
||||
if ($adm_relative_path !== null && is_dir($this->phpbb_root_path . $adm_relative_path . 'style/'))
|
||||
{
|
||||
$this->twig->getLoader()->setPaths($this->phpbb_root_path . $adm_relative_path . 'style/', 'admin');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -165,51 +140,90 @@ class phpbb_template_twig implements phpbb_template
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the template filenames for handles.
|
||||
* Get the style tree of the style preferred by the current user
|
||||
*
|
||||
* @param array $filename_array Should be a hash of handle => filename pairs.
|
||||
* @return array Style tree, most specific first
|
||||
*/
|
||||
public function get_user_style()
|
||||
{
|
||||
$style_list = array(
|
||||
$this->user->style['style_path'],
|
||||
);
|
||||
|
||||
if ($this->user->style['style_parent_id'])
|
||||
{
|
||||
$style_list = array_merge($style_list, array_reverse(explode('/', $this->user->style['style_parent_tree'])));
|
||||
}
|
||||
|
||||
return $style_list;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set style location based on (current) user's chosen style.
|
||||
*
|
||||
* @param array $style_directories The directories to add style paths for
|
||||
* E.g. array('ext/foo/bar/styles', 'styles')
|
||||
* Default: array('styles') (phpBB's style directory)
|
||||
* @return phpbb_template $this
|
||||
*/
|
||||
public function set_filenames(array $filename_array)
|
||||
public function set_style($style_directories = array('styles'))
|
||||
{
|
||||
$this->filenames = array_merge($this->filenames, $filename_array);
|
||||
if ($style_directories !== array('styles') && $this->twig->getLoader()->getPaths('core') === array())
|
||||
{
|
||||
// We should set up the core styles path since not already setup
|
||||
$this->set_style();
|
||||
}
|
||||
|
||||
$names = $this->get_user_style();
|
||||
|
||||
$paths = array();
|
||||
foreach ($style_directories as $directory)
|
||||
{
|
||||
foreach ($names as $name)
|
||||
{
|
||||
$path = $this->phpbb_root_path . trim($directory, '/') . "/{$name}/template/";
|
||||
|
||||
if (is_dir($path))
|
||||
{
|
||||
$paths[] = $path;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// If we're setting up the main phpBB styles directory and the core
|
||||
// namespace isn't setup yet, we will set it up now
|
||||
if ($style_directories === array('styles') && $this->twig->getLoader()->getPaths('core') === array())
|
||||
{
|
||||
// Set up the core style paths namespace
|
||||
$this->twig->getLoader()->setPaths($paths, 'core');
|
||||
}
|
||||
|
||||
$this->set_custom_style($names, $paths);
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the style names/paths corresponding to style hierarchy being compiled
|
||||
* and/or rendered.
|
||||
* Set custom style location (able to use directory outside of phpBB).
|
||||
*
|
||||
* @param array $style_names List of style names in inheritance tree order
|
||||
* @param array $style_paths List of style paths in inheritance tree order
|
||||
* @param bool $is_core True if the style names are the "core" styles for this page load
|
||||
* Core means the main phpBB template files
|
||||
* Note: Templates are still compiled to phpBB's cache directory.
|
||||
*
|
||||
* @param string|array $names Array of names or string of name of template(s) in inheritance tree order, used by extensions.
|
||||
* @param string|array or string $paths Array of style paths, relative to current root directory
|
||||
* @return phpbb_template $this
|
||||
*/
|
||||
public function set_style_names(array $style_names, array $style_paths, $is_core = false)
|
||||
public function set_custom_style($names, $paths)
|
||||
{
|
||||
$this->style_names = $style_names;
|
||||
$paths = (is_string($paths)) ? array($paths) : $paths;
|
||||
$names = (is_string($names)) ? array($names) : $names;
|
||||
|
||||
// Set as __main__ namespace
|
||||
$this->twig->getLoader()->setPaths($style_paths);
|
||||
|
||||
// Core style namespace from phpbb_style::set_style()
|
||||
if ($is_core)
|
||||
{
|
||||
$this->twig->getLoader()->setPaths($style_paths, 'core');
|
||||
}
|
||||
|
||||
// Add admin namespace
|
||||
if (is_dir($this->phpbb_root_path . $this->adm_relative_path . 'style/'))
|
||||
{
|
||||
$this->twig->getLoader()->setPaths($this->phpbb_root_path . $this->adm_relative_path . 'style/', 'admin');
|
||||
}
|
||||
$this->twig->getLoader()->setPaths($paths);
|
||||
|
||||
// Add all namespaces for all extensions
|
||||
if ($this->extension_manager instanceof phpbb_extension_manager)
|
||||
{
|
||||
$style_names[] = 'all';
|
||||
$names[] = 'all';
|
||||
|
||||
foreach ($this->extension_manager->all_enabled() as $ext_namespace => $ext_path)
|
||||
{
|
||||
@@ -217,7 +231,7 @@ class phpbb_template_twig implements phpbb_template
|
||||
$namespace = str_replace('/', '_', $ext_namespace);
|
||||
$paths = array();
|
||||
|
||||
foreach ($style_names as $style_name)
|
||||
foreach ($names as $style_name)
|
||||
{
|
||||
$ext_style_path = $ext_path . 'styles/' . $style_name . '/template';
|
||||
|
||||
@@ -234,31 +248,6 @@ class phpbb_template_twig implements phpbb_template
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Clears all variables and blocks assigned to this template.
|
||||
*
|
||||
* @return phpbb_template $this
|
||||
*/
|
||||
public function destroy()
|
||||
{
|
||||
$this->context = array();
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Reset/empty complete block
|
||||
*
|
||||
* @param string $blockname Name of block to destroy
|
||||
* @return phpbb_template $this
|
||||
*/
|
||||
public function destroy_block_vars($blockname)
|
||||
{
|
||||
$this->context->destroy_block_vars($blockname);
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Display a template for provided handle.
|
||||
*
|
||||
@@ -282,28 +271,6 @@ class phpbb_template_twig implements phpbb_template
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Calls hook if any is defined.
|
||||
*
|
||||
* @param string $handle Template handle being displayed.
|
||||
* @param string $method Method name of the caller.
|
||||
*/
|
||||
protected function call_hook($handle, $method)
|
||||
{
|
||||
global $phpbb_hook;
|
||||
|
||||
if (!empty($phpbb_hook) && $phpbb_hook->call_hook(array(__CLASS__, $method), $handle, $this))
|
||||
{
|
||||
if ($phpbb_hook->hook_return(array(__CLASS__, $method)))
|
||||
{
|
||||
$result = $phpbb_hook->hook_return_result(array(__CLASS__, $method));
|
||||
return array($result);
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Display the handle and assign the output to a template variable
|
||||
* or return the compiled result.
|
||||
@@ -325,105 +292,12 @@ class phpbb_template_twig implements phpbb_template
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Assign key variable pairs from an array
|
||||
*
|
||||
* @param array $vararray A hash of variable name => value pairs
|
||||
* @return phpbb_template $this
|
||||
*/
|
||||
public function assign_vars(array $vararray)
|
||||
{
|
||||
foreach ($vararray as $key => $val)
|
||||
{
|
||||
$this->assign_var($key, $val);
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Assign a single scalar value to a single key.
|
||||
*
|
||||
* Value can be a string, an integer or a boolean.
|
||||
*
|
||||
* @param string $varname Variable name
|
||||
* @param string $varval Value to assign to variable
|
||||
* @return phpbb_template $this
|
||||
*/
|
||||
public function assign_var($varname, $varval)
|
||||
{
|
||||
$this->context->assign_var($varname, $varval);
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Append text to the string value stored in a key.
|
||||
*
|
||||
* Text is appended using the string concatenation operator (.).
|
||||
*
|
||||
* @param string $varname Variable name
|
||||
* @param string $varval Value to append to variable
|
||||
* @return phpbb_template $this
|
||||
*/
|
||||
public function append_var($varname, $varval)
|
||||
{
|
||||
$this->context->append_var($varname, $varval);
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Assign key variable pairs from an array to a specified block
|
||||
* @param string $blockname Name of block to assign $vararray to
|
||||
* @param array $vararray A hash of variable name => value pairs
|
||||
* @return phpbb_template $this
|
||||
*/
|
||||
public function assign_block_vars($blockname, array $vararray)
|
||||
{
|
||||
$this->context->assign_block_vars($blockname, $vararray);
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Change already assigned key variable pair (one-dimensional - single loop entry)
|
||||
*
|
||||
* An example of how to use this function:
|
||||
* {@example alter_block_array.php}
|
||||
*
|
||||
* @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
|
||||
*/
|
||||
public function alter_block_array($blockname, array $vararray, $key = false, $mode = 'insert')
|
||||
{
|
||||
return $this->context->alter_block_array($blockname, $vararray, $key, $mode);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get template vars in a format Twig will use (from the context)
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function get_template_vars()
|
||||
protected function get_template_vars()
|
||||
{
|
||||
$context_vars = $this->context->get_data_ref();
|
||||
|
||||
@@ -442,17 +316,6 @@ class phpbb_template_twig implements phpbb_template
|
||||
return $vars;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a filename from the handle
|
||||
*
|
||||
* @param string $handle
|
||||
* @return string
|
||||
*/
|
||||
protected function get_filename_from_handle($handle)
|
||||
{
|
||||
return (isset($this->filenames[$handle])) ? $this->filenames[$handle] : $handle;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get path to template for handle (required for BBCode parser)
|
||||
*
|
||||
|
Reference in New Issue
Block a user