diff options
| author | Oleg Pudeyev <oleg@bsdpower.com> | 2012-06-12 01:32:49 -0400 |
|---|---|---|
| committer | Oleg Pudeyev <oleg@bsdpower.com> | 2012-11-02 19:39:07 -0400 |
| commit | bf66c47650682331454487c9db3999265f06df78 (patch) | |
| tree | 17ac8a330536d89d0ae6a2d261dcabc0c85db2f5 /phpBB/includes/style | |
| parent | b878d5daa9e7210c35b2d06e1680f22eb6701c6f (diff) | |
| download | forums-bf66c47650682331454487c9db3999265f06df78.tar forums-bf66c47650682331454487c9db3999265f06df78.tar.gz forums-bf66c47650682331454487c9db3999265f06df78.tar.bz2 forums-bf66c47650682331454487c9db3999265f06df78.tar.xz forums-bf66c47650682331454487c9db3999265f06df78.zip | |
[ticket/10933] Remaining documentation for added functions in resource locator
PHPBB3-10933
Diffstat (limited to 'phpBB/includes/style')
| -rw-r--r-- | phpBB/includes/style/resource_locator.php | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/phpBB/includes/style/resource_locator.php b/phpBB/includes/style/resource_locator.php index 37ea2fed40..6181653d4e 100644 --- a/phpBB/includes/style/resource_locator.php +++ b/phpBB/includes/style/resource_locator.php @@ -63,6 +63,11 @@ class phpbb_style_resource_locator implements phpbb_template_locator */ private $filenames = array(); + /** + * Constructor. + * + * Sets default template path to template/. + */ public function __construct() { $this->set_default_template_path(); @@ -100,12 +105,24 @@ class phpbb_style_resource_locator implements phpbb_template_locator /** * Sets the location of templates directory within style directories. + * + * The location must be a relative path, with a trailing slash. + * Typically it is one directory level deep, e.g. "template/". + * + * @param string $template_path Relative path to templates directory within style directories + * @return void */ public function set_template_path($template_path) { $this->template_path = $template_path; } + /** + * Sets the location of templates directory within style directories + * to the default, which is "template/". + * + * @return void + */ public function set_default_template_path() { $this->template_path = 'template/'; |