diff options
| author | Chris Smith <toonarmy@phpbb.com> | 2008-11-24 21:59:33 +0000 |
|---|---|---|
| committer | Chris Smith <toonarmy@phpbb.com> | 2008-11-24 21:59:33 +0000 |
| commit | 332521a3696df8e1504933bee5658d005549f3b4 (patch) | |
| tree | 28bb6252017cb568046517b4bfd4b9a9904aee0f /phpBB/includes/functions_template.php | |
| parent | 9954d9c29f551acc0ad88bf4ecc806c51c764a6e (diff) | |
| download | forums-332521a3696df8e1504933bee5658d005549f3b4.tar forums-332521a3696df8e1504933bee5658d005549f3b4.tar.gz forums-332521a3696df8e1504933bee5658d005549f3b4.tar.bz2 forums-332521a3696df8e1504933bee5658d005549f3b4.tar.xz forums-332521a3696df8e1504933bee5658d005549f3b4.zip | |
- Make a start on completing the phpDoc comments for the template engine
- Tidy template engine code, mainly PHP5 stuff, made some methods void instead of just returning true
- Add tests for the remaining untested compilation code
git-svn-id: file:///svn/phpbb/trunk@9115 89ea8834-ac86-4346-8a33-228a782c2dd0
Diffstat (limited to 'phpBB/includes/functions_template.php')
| -rw-r--r-- | phpBB/includes/functions_template.php | 66 |
1 files changed, 54 insertions, 12 deletions
diff --git a/phpBB/includes/functions_template.php b/phpBB/includes/functions_template.php index 8672c00d50..c8c79ab5e4 100644 --- a/phpBB/includes/functions_template.php +++ b/phpBB/includes/functions_template.php @@ -19,19 +19,32 @@ if (!defined('IN_PHPBB')) /** * The template filter that does the actual compilation * @see template_compile + * @package phpBB3 * */ class template_filter extends php_user_filter { + /** + * @var string Replaceable tokens regex + */ private $regex = '~<!-- ([A-Z][A-Z_0-9]+)(?: (.*?) ?)?-->|{((?:[a-z][a-z_0-9]+\.)*\\$?[A-Z][A-Z_0-9]+)}~'; - private $blocks = array(); + /** + * @var array + */ private $block_names = array(); + + /** + * @var array + */ private $block_else_level = array(); + /** + * @var string + */ private $chunk; - function filter($in, $out, &$consumed, $closing) + public function filter($in, $out, &$consumed, $closing) { $written = false; @@ -203,6 +216,12 @@ class template_filter extends php_user_filter $no_nesting = false; // Is the designer wanting to call another loop in a loop? + // <!-- BEGIN loop --> + // <!-- BEGIN !loop2 --> + // <!-- END !loop2 --> + // <!-- END loop --> + // 'loop2' is actually on the same nesting level as 'loop' you assign + // variables to it with template->assign_block_vars('loop2', array(...)) if (strpos($tag_args, '!') === 0) { // Count the number if ! occurrences (not allowed in vars) @@ -605,10 +624,15 @@ class template_filter extends php_user_filter * block namespace. This is a string of the form: * ' . $_tpldata['parent'][$_parent_i]['$child1'][$_child1_i]['$child2'][$_child2_i]...['varname'] . ' * It's ready to be inserted into an "echo" line in one of the templates. - * NOTE: expects a trailing "." on the namespace. + * * @access private + * @param string $namespace Namespace to access (expects a trailing "." on the namespace) + * @param string $varname Variable name to use + * @param bool $echo If true return an echo statement, otherwise a reference to the internal variable + * @param bool $defop If true this is a variable created with the DEFINE construct, otherwise template variable + * @return string Code to access variable or echo it if $echo is true */ - function generate_block_varref($namespace, $varname, $echo = true, $defop = false) + private function generate_block_varref($namespace, $varname, $echo = true, $defop = false) { // Strip the trailing period. $namespace = substr($namespace, 0, -1); @@ -653,11 +677,13 @@ class template_filter extends php_user_filter * (possibly nested) block namespace. This is a string of the form: * $_tpldata['parent'][$_parent_i]['$child1'][$_child1_i]['$child2'][$_child2_i]...['$childN'] * - * If $include_last_iterator is true, then [$_childN_i] will be appended to the form shown above. - * NOTE: does not expect a trailing "." on the blockname. * @access private + * @param string $blockname Block to access (does not expect a trailing "." on the blockname) + * @param bool $include_last_iterator If $include_last_iterator is true, then [$_childN_i] will be appended to the form shown above. + * @param bool $defop If true this is a variable created with the DEFINE construct, otherwise template variable + * @return string Code to access variable */ - function generate_block_data_ref($blockname, $include_last_iterator, $defop = false) + private function generate_block_data_ref($blockname, $include_last_iterator, $defop = false) { // Get an array of the blocks involved. $blocks = explode('.', $blockname); @@ -712,14 +738,18 @@ stream_filter_register('template', 'template_filter'); * DEFINE directive inspired by a request by Cyberalien * * @package phpBB3 +* @uses template_filter As a PHP stream filter to perform compilation of templates */ class template_compile { - + /** + * @var template Reference to the {@link template template} object performing compilation + */ private $template; /** * Constructor + * @param template $template {@link template Template} object performing compilation */ function __construct(template $template) { @@ -729,8 +759,10 @@ class template_compile /** * Load template source from file * @access public + * @param string $handle Template handle we wish to load + * @return bool Return true on success otherwise false */ - public function _tpl_load_file($handle/*, $store_in_db = false*/) + public function _tpl_load_file($handle) { // Try and open template for read if (!file_exists($this->template->files[$handle])) @@ -740,9 +772,14 @@ class template_compile // Actually compile the code now. return $this->compile_write($handle, $this->template->files[$handle]); - } + /** + * Load template source from file + * @access public + * @param string $handle Template handle we wish to compile + * @return string|bool Return compiled code on successful compilation otherwise false + */ public function _tpl_gen_src($handle) { // Try and open template for read @@ -752,12 +789,15 @@ class template_compile } // Actually compile the code now. - return $this->compile_gen(/*$handle, */$this->template->files[$handle]); + return $this->compile_gen($this->template->files[$handle]); } /** * Write compiled file to cache directory * @access private + * @param string $handle Template handle to compile + * @param string $source_file Source template file + * @return bool Return true on success otherwise false */ private function compile_write($handle, $source_file) { @@ -788,8 +828,10 @@ class template_compile /** * Generate source for eval() * @access private + * @param string $source_file Source template file + * @return string|bool Return compiled code on successful compilation otherwise false */ - private function compile_gen(/*$handle, */$source_file) + private function compile_gen($source_file) { $source_handle = @fopen($source_file, 'rb'); $destination_handle = @fopen('php://temp' ,'r+b'); |