[ticket/10933] Remaining documentation for added functions in resource locator

PHPBB3-10933
This commit is contained in:
Oleg Pudeyev 2012-06-12 01:32:49 -04:00
parent b878d5daa9
commit bf66c47650

View file

@ -63,6 +63,11 @@ class phpbb_style_resource_locator implements phpbb_template_locator
*/ */
private $filenames = array(); private $filenames = array();
/**
* Constructor.
*
* Sets default template path to template/.
*/
public function __construct() public function __construct()
{ {
$this->set_default_template_path(); $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. * 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) public function set_template_path($template_path)
{ {
$this->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() public function set_default_template_path()
{ {
$this->template_path = 'template/'; $this->template_path = 'template/';