diff options
| author | Oleg Pudeyev <oleg@bsdpower.com> | 2011-05-11 09:17:20 -0400 |
|---|---|---|
| committer | Oleg Pudeyev <oleg@bsdpower.com> | 2011-05-12 20:13:31 -0400 |
| commit | d6f75e97d60981efd3ca2792e1a9d379d922631d (patch) | |
| tree | 46dcad634ea9c2f6a700997d6286dd8387952fe2 | |
| parent | 635460fa6dda70be8ae8b36c4c4be012c9c0a590 (diff) | |
| download | forums-d6f75e97d60981efd3ca2792e1a9d379d922631d.tar forums-d6f75e97d60981efd3ca2792e1a9d379d922631d.tar.gz forums-d6f75e97d60981efd3ca2792e1a9d379d922631d.tar.bz2 forums-d6f75e97d60981efd3ca2792e1a9d379d922631d.tar.xz forums-d6f75e97d60981efd3ca2792e1a9d379d922631d.zip | |
[feature/template-engine] Added docblocks to get_*_ref in context.
PHPBB3-9726
| -rw-r--r-- | phpBB/includes/template/context.php | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/phpBB/includes/template/context.php b/phpBB/includes/template/context.php index 695f6e0ed3..73f1373655 100644 --- a/phpBB/includes/template/context.php +++ b/phpBB/includes/template/context.php @@ -66,6 +66,17 @@ class phpbb_template_context 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() { // returning a reference directly is not @@ -74,6 +85,17 @@ class phpbb_template_context 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() { // rootref is already a reference |