diff options
| author | Andreas Fischer <bantu@phpbb.com> | 2013-10-10 23:39:09 +0200 |
|---|---|---|
| committer | Andreas Fischer <bantu@phpbb.com> | 2013-10-10 23:39:09 +0200 |
| commit | 353ac33d5cea1752047779eb8c70c7ce3a64b6c8 (patch) | |
| tree | 76e08c4e16c68256700506b7111c3cbb547dc877 /phpBB/phpbb/template/template.php | |
| parent | 0228424983e35badc779923a1f0398fc3ab7c8b2 (diff) | |
| parent | b59131f558a6d0fe4c836e2658152c8698f0cd22 (diff) | |
| download | forums-353ac33d5cea1752047779eb8c70c7ce3a64b6c8.tar forums-353ac33d5cea1752047779eb8c70c7ce3a64b6c8.tar.gz forums-353ac33d5cea1752047779eb8c70c7ce3a64b6c8.tar.bz2 forums-353ac33d5cea1752047779eb8c70c7ce3a64b6c8.tar.xz forums-353ac33d5cea1752047779eb8c70c7ce3a64b6c8.zip | |
Merge remote-tracking branch 'phpbb/develop' into ticket/11621
* phpbb/develop: (542 commits)
[ticket/11901] Pass empty string as relative_url for non-local magic URL.
[ticket/11898] Correct adm_relative_path created by installer
[ticket/11898] Correct admin S_LOGIN_ACTION
[ticket/11892] Fix undefined variables: to_forum_id & to_topic_id
[ticket/11890] Fix untranslated string when deleting posts through MCP.
[ticket/11895] Fix undefined $forum_id
[ticket/10383] Update the results without the overlay popup.
[ticket/10383] Make the content transitions smoother.
[ticket/10383] AJAXify poll voting
[ticket/11888] Update default search backend in namespaces migration
[ticket/11739] Rename “Remember Me” login keys module
[ticket/11893] Remove unnecessary <fieldset> causing a large font size
[ticket/11894] Fix typo in "Delete post" option
[ticket/11888] Use \phpbb\search\fulltext_native as search backend config
[ticket/11608] Mark failed test as incomplete for mysql search backend
[ticket/11608] Update search backend class names to namespaces
[ticket/11608] Move markIncomplete to search backends test
[ticket/11608] Rename base search test class file
[ticket/11608] Remove suffix test from base class
[ticket/11608] Mark postgres search not found test as incomplete
...
Diffstat (limited to 'phpBB/phpbb/template/template.php')
| -rw-r--r-- | phpBB/phpbb/template/template.php | 56 |
1 files changed, 38 insertions, 18 deletions
diff --git a/phpBB/phpbb/template/template.php b/phpBB/phpbb/template/template.php index 89a01e924d..cf38bba522 100644 --- a/phpBB/phpbb/template/template.php +++ b/phpBB/phpbb/template/template.php @@ -7,6 +7,8 @@ * */ +namespace phpbb\template; + /** * @ignore */ @@ -15,13 +17,13 @@ if (!defined('IN_PHPBB')) exit; } -interface phpbb_template +interface template { /** * Clear the cache * - * @return phpbb_template + * @return \phpbb\template\template */ public function clear_cache(); @@ -29,24 +31,42 @@ interface phpbb_template * Sets the template filenames for handles. * * @param array $filename_array Should be a hash of handle => filename pairs. - * @return phpbb_template $this + * @return \phpbb\template\template $this */ 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 + * + * @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\template $this + */ + 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 array $style_names List of style names in inheritance tree order - * @param array $style_paths List of style paths in inheritance tree order - * @return phpbb_template $this + * @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\template $this */ - public function set_style_names(array $style_names, array $style_paths); + public function set_custom_style($names, $paths); /** * Clears all variables and blocks assigned to this template. * - * @return phpbb_template $this + * @return \phpbb\template\template $this */ public function destroy(); @@ -54,7 +74,7 @@ interface phpbb_template * Reset/empty complete block * * @param string $blockname Name of block to destroy - * @return phpbb_template $this + * @return \phpbb\template\template $this */ public function destroy_block_vars($blockname); @@ -66,7 +86,7 @@ interface phpbb_template * This function calls hooks. * * @param string $handle Handle to display - * @return phpbb_template $this + * @return \phpbb\template\template $this */ public function display($handle); @@ -77,7 +97,7 @@ interface phpbb_template * @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 - * @return phpbb_template|string if $return_content is true return string of the compiled handle, otherwise return $this + * @return \phpbb\template\template|string if $return_content is true return string of the compiled handle, otherwise return $this */ public function assign_display($handle, $template_var = '', $return_content = true); @@ -85,7 +105,7 @@ interface phpbb_template * Assign key variable pairs from an array * * @param array $vararray A hash of variable name => value pairs - * @return phpbb_template $this + * @return \phpbb\template\template $this */ public function assign_vars(array $vararray); @@ -96,7 +116,7 @@ interface phpbb_template * * @param string $varname Variable name * @param string $varval Value to assign to variable - * @return phpbb_template $this + * @return \phpbb\template\template $this */ public function assign_var($varname, $varval); @@ -107,7 +127,7 @@ interface phpbb_template * * @param string $varname Variable name * @param string $varval Value to append to variable - * @return phpbb_template $this + * @return \phpbb\template\template $this */ public function append_var($varname, $varval); @@ -115,7 +135,7 @@ interface phpbb_template * 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 + * @return \phpbb\template\template $this */ public function assign_block_vars($blockname, array $vararray); @@ -139,7 +159,7 @@ interface phpbb_template * @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). + * 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) |