diff options
| author | Nils Adermann <naderman@naderman.de> | 2011-11-18 15:29:32 +0100 |
|---|---|---|
| committer | Nils Adermann <naderman@naderman.de> | 2011-11-18 15:29:32 +0100 |
| commit | 7cdc4bba2512089a02fbfa5cf4e5babbf9e20475 (patch) | |
| tree | 81ec8e5c3d287d65f0b5ddf845d893e141716545 /phpBB/includes/template | |
| parent | 8be1500048c2ae811f30e0bd402d7596b60fc2d9 (diff) | |
| download | forums-7cdc4bba2512089a02fbfa5cf4e5babbf9e20475.tar forums-7cdc4bba2512089a02fbfa5cf4e5babbf9e20475.tar.gz forums-7cdc4bba2512089a02fbfa5cf4e5babbf9e20475.tar.bz2 forums-7cdc4bba2512089a02fbfa5cf4e5babbf9e20475.tar.xz forums-7cdc4bba2512089a02fbfa5cf4e5babbf9e20475.zip | |
[feature/extension-manager] Clear up docs of extension related template changes
PHPBB3-10323
Diffstat (limited to 'phpBB/includes/template')
| -rw-r--r-- | phpBB/includes/template/extension_path_provider.php | 43 | ||||
| -rw-r--r-- | phpBB/includes/template/locator.php | 4 | ||||
| -rw-r--r-- | phpBB/includes/template/path_provider.php | 3 |
3 files changed, 35 insertions, 15 deletions
diff --git a/phpBB/includes/template/extension_path_provider.php b/phpBB/includes/template/extension_path_provider.php index 9578702b65..0feeaafed0 100644 --- a/phpBB/includes/template/extension_path_provider.php +++ b/phpBB/includes/template/extension_path_provider.php @@ -16,7 +16,7 @@ if (!defined('IN_PHPBB')) } /** -* Provides a template locator with template paths and extension template paths +* Provides a template locator with core template paths and extension template paths * * Finds installed template paths and makes them available to the locator. * @@ -24,24 +24,41 @@ if (!defined('IN_PHPBB')) */ class phpbb_template_extension_path_provider extends phpbb_extension_provider implements phpbb_template_path_provider_interface { + /** + * Optional prefix for template paths searched within extensions. + * + * Empty by default. Relative to the extension directory. As an example, it + * could be adm/ for admin templates. + * + * @var string + */ protected $ext_dir_prefix = ''; - protected $base_paths; + + /** + * A provider of paths to be searched for templates + * @var phpbb_template_path_provider + */ + protected $base_path_provider; /** * Constructor stores extension manager * * @param phpbb_extension_manager $extension_manager phpBB extension manager - * @param phpbb_template_path_provider $base_paths A simple path provider + * @param phpbb_template_path_provider $base_path_provider A simple path provider * to provide paths to be located in extensions */ - public function __construct(phpbb_extension_manager $extension_manager, phpbb_template_path_provider $base_paths) + public function __construct(phpbb_extension_manager $extension_manager, phpbb_template_path_provider $base_path_provider) { parent::__construct($extension_manager); - $this->base_paths = $base_paths; + $this->base_path_provider = $base_path_provider; } /** - * Defines a prefix to use for template paths in extensions + * Sets a prefix for template paths searched within extensions. + * + * The prefix is inserted between the extension's path e.g. ext/foo/ and + * the looked up template path, e.g. styles/bar/template/some.html. So it + * should not have a leading slash, but should have a trailing slash. * * @param string $ext_dir_prefix The prefix including trailing slash * @return null @@ -54,9 +71,9 @@ class phpbb_template_extension_path_provider extends phpbb_extension_provider im /** * Finds template paths using the extension manager * - * Finds paths with the same name (e.g. styles/prosilver/template/) in all - * active extensions. Then appends the actual template paths based in the - * current working directory. + * Locates a path (e.g. styles/prosilver/template/) in all active extensions. + * Then appends the core template paths based in the current working + * directory. * * @return array List of template paths */ @@ -65,7 +82,7 @@ class phpbb_template_extension_path_provider extends phpbb_extension_provider im $directories = array(); $finder = $this->extension_manager->get_finder(); - foreach ($this->base_paths as $path) + foreach ($this->base_path_provider as $path) { if ($path && !phpbb_is_absolute($path)) { @@ -76,7 +93,7 @@ class phpbb_template_extension_path_provider extends phpbb_extension_provider im } } - foreach ($this->base_paths as $path) + foreach ($this->base_path_provider as $path) { $directories[] = $path; } @@ -97,7 +114,7 @@ class phpbb_template_extension_path_provider extends phpbb_extension_provider im */ public function set_templates(array $templates, $style_root_path) { - $this->base_paths->set_templates($templates, $style_root_path); + $this->base_path_provider->set_templates($templates, $style_root_path); $this->items = null; } @@ -108,6 +125,6 @@ class phpbb_template_extension_path_provider extends phpbb_extension_provider im */ public function get_main_template_path() { - return $this->base_paths->get_main_template_path(); + return $this->base_path_provider->get_main_template_path(); } } diff --git a/phpBB/includes/template/locator.php b/phpBB/includes/template/locator.php index 44cd2cd7b9..ee9bfa7d48 100644 --- a/phpBB/includes/template/locator.php +++ b/phpBB/includes/template/locator.php @@ -71,8 +71,8 @@ class phpbb_template_locator * Sets the list of template paths * * These paths will be searched for template files in the provided order. - * Paths may be outside of phpBB, but will still be cached to phpBB cache - * directory. + * Paths may be outside of phpBB, but templates loaded from these paths + * will still be cached. * * @param array $template_paths An array of paths to template directories * @return null diff --git a/phpBB/includes/template/path_provider.php b/phpBB/includes/template/path_provider.php index a56269d3c8..c243d1b115 100644 --- a/phpBB/includes/template/path_provider.php +++ b/phpBB/includes/template/path_provider.php @@ -40,6 +40,9 @@ class phpbb_template_path_provider implements IteratorAggregate, phpbb_template_ /** * Overwrites the current template names and paths * + * The first element of the passed templates map, is considered the main + * template and can be retrieved through get_main_template_path(). + * * @param array $templates An associative map from template names to paths. * The first element is the main template. * If the path is false, it will be generated from |