makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-28 22:28:51 +00:00
Code Issues Projects Releases Packages Wiki Activity

[feature/template-engine] Added docblocks to get_*_ref in context.

Browse source 
PHPBB3-9726
This commit is contained in:
Oleg Pudeyev 2011-05-11 09:17:20 -04:00
parent 635460fa6d
commit d6f75e97d6
1 changed files with 22 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
phpBB/includes/template/context.php
View file

@ -66,6 +66,17 @@ class phpbb_template_context
return true; return true;
} }
/**
* Returns a reference to template data array.
*
* This function is public so that template renderer may invoke it.
* Users should alter template variables via functions in phpbb_template.
*
* Note: modifying returned array will affect data stored in the context.
*
* @access public
* @return array template data
*/
public function get_data_ref() public function get_data_ref()
{ {
// returning a reference directly is not // returning a reference directly is not
@ -74,6 +85,17 @@ class phpbb_template_context
return $ref; return $ref;
} }
/**
* Returns a reference to template root scope.
*
* This function is public so that template renderer may invoke it.
* Users should not need to invoke this function.
*
* Note: modifying returned array will affect data stored in the context.
*
* @access public
* @return array template data
*/
public function get_root_ref() public function get_root_ref()
{ {
// rootref is already a reference // rootref is already a reference