diff options
| author | Igor Wiedler <igor@wiedler.ch> | 2011-11-19 01:20:22 +0100 |
|---|---|---|
| committer | Igor Wiedler <igor@wiedler.ch> | 2011-11-19 01:20:22 +0100 |
| commit | b7c4fb38de526eb446de20c0b8e54d7cf9108834 (patch) | |
| tree | e5a09515fb73ca34e01736c681a733f40b2c89ba /phpBB/includes/template/extension_path_provider.php | |
| parent | 3df4b83cd3306013d78b93024905a67ecc97df25 (diff) | |
| parent | 5f48f55cca5d0a6a2c51cdcc8a60b475354f50b1 (diff) | |
| download | forums-b7c4fb38de526eb446de20c0b8e54d7cf9108834.tar forums-b7c4fb38de526eb446de20c0b8e54d7cf9108834.tar.gz forums-b7c4fb38de526eb446de20c0b8e54d7cf9108834.tar.bz2 forums-b7c4fb38de526eb446de20c0b8e54d7cf9108834.tar.xz forums-b7c4fb38de526eb446de20c0b8e54d7cf9108834.zip | |
Merge remote-tracking branch 'naderman/feature/extension-manager' into develop
* naderman/feature/extension-manager: (67 commits)
[feature/extension-manager] Removing now unused acp_search code
[feature/extension-manager] Split disabling extensions up into steps as well
[feature/extension-manager] Add documentation on caching in ext finder
[feature/extension-manager] Reference correct new module basenames in install
[feature/extension-manager] Rename default methods to core methods on finder.
[feature/extension-manager] Document what the class loader stores in cache
[feature/extension-manager] Add docblock to cached paths map in class loader
[feature/extension-manager] Clear up docs of extension related template changes
[feature/extension-manager] Use "core files" instead of "global files" in docs
[feature/extension-manager] Add docblocks to new search backend methods
[feature/extension-manager] Add docblocks to new methods in functions_module
[feature/extension-manager] Clarify comment on ext meta class instantiator
[feature/extension-manager] Add more info on suffixes in extension finder
[feature/extension-manager] Clarify is_dir parameter description
[feature/extension-manager] Clarify class finding method docblock
[feature/extension-manager] Correct default path comment & remove double strlen
[feature/extension-manager] Fix "disbale" typo in comment
[feature/extension-manager] Properly remove old ACP language loading code
[feature/extension-manager] Support extensions in subdirectories of ext/
[feature/extension-manager] Add prefix to extension meta data / install classes
...
Diffstat (limited to 'phpBB/includes/template/extension_path_provider.php')
| -rw-r--r-- | phpBB/includes/template/extension_path_provider.php | 130 |
1 files changed, 130 insertions, 0 deletions
diff --git a/phpBB/includes/template/extension_path_provider.php b/phpBB/includes/template/extension_path_provider.php new file mode 100644 index 0000000000..0feeaafed0 --- /dev/null +++ b/phpBB/includes/template/extension_path_provider.php @@ -0,0 +1,130 @@ +<?php +/** +* +* @package phpBB3 +* @copyright (c) 2011 phpBB Group +* @license http://opensource.org/licenses/gpl-license.php GNU Public License +* +*/ + +/** +* @ignore +*/ +if (!defined('IN_PHPBB')) +{ + exit; +} + +/** +* Provides a template locator with core template paths and extension template paths +* +* Finds installed template paths and makes them available to the locator. +* +* @package phpBB3 +*/ +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 = ''; + + /** + * 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_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_path_provider) + { + parent::__construct($extension_manager); + $this->base_path_provider = $base_path_provider; + } + + /** + * 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 + */ + public function set_ext_dir_prefix($ext_dir_prefix) + { + $this->ext_dir_prefix = $ext_dir_prefix; + } + + /** + * Finds template paths using the extension manager + * + * 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 + */ + public function find() + { + $directories = array(); + + $finder = $this->extension_manager->get_finder(); + foreach ($this->base_path_provider as $path) + { + if ($path && !phpbb_is_absolute($path)) + { + $directories = array_merge($directories, $finder + ->directory('/' . $this->ext_dir_prefix . $path) + ->get_directories() + ); + } + } + + foreach ($this->base_path_provider as $path) + { + $directories[] = $path; + } + + return $directories; + } + + /** + * Overwrites the current template names and paths + * + * @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 + * the supplied name. + * @param string $style_root_path The root directory for styles identified + * by name only. + * @return null + */ + public function set_templates(array $templates, $style_root_path) + { + $this->base_path_provider->set_templates($templates, $style_root_path); + $this->items = null; + } + + /** + * Retrieves the path to the main template passed into set_templates() + * + * @return string Main template path + */ + public function get_main_template_path() + { + return $this->base_path_provider->get_main_template_path(); + } +} |