aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/includes/template/path_provider.php
diff options
context:
space:
mode:
Diffstat (limited to 'phpBB/includes/template/path_provider.php')
-rw-r--r--phpBB/includes/template/path_provider.php102
1 files changed, 102 insertions, 0 deletions
diff --git a/phpBB/includes/template/path_provider.php b/phpBB/includes/template/path_provider.php
new file mode 100644
index 0000000000..c243d1b115
--- /dev/null
+++ b/phpBB/includes/template/path_provider.php
@@ -0,0 +1,102 @@
+<?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 paths
+*
+* Finds installed template paths and makes them available to the locator.
+*
+* @package phpBB3
+*/
+class phpbb_template_path_provider implements IteratorAggregate, phpbb_template_path_provider_interface
+{
+ protected $main_template_name = '';
+ protected $paths = array();
+
+ /**
+ * Ignores the extension dir prefix
+ *
+ * @param string $ext_dir_prefix The prefix including trailing slash
+ * @return null
+ */
+ public function set_ext_dir_prefix($ext_dir_prefix)
+ {
+ }
+
+ /**
+ * 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
+ * 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->paths = array();
+
+ foreach ($templates as $name => $path)
+ {
+ if (!$path)
+ {
+ $path = $style_root_path . $this->template_root_for_style($name);
+ }
+
+ $this->paths[] = $path;
+ }
+
+ $this->main_template_path = $this->paths[0];
+ }
+
+ /**
+ * Retrieves the path to the main template passed into set_templates()
+ *
+ * @return string Main template path
+ */
+ public function get_main_template_path()
+ {
+ return $this->main_template_path;
+ }
+
+ /**
+ * Converts a style name to relative (to board root or extension) path to
+ * the style's template files.
+ *
+ * @param $style_name string Style name
+ * @return string Path to style template files
+ */
+ private function template_root_for_style($style_name)
+ {
+ return 'styles/' . $style_name . '/template';
+ }
+
+ /**
+ * Retrieve an iterator over all template paths
+ *
+ * @return ArrayIterator An iterator for the array of template paths
+ */
+ public function getIterator()
+ {
+ return new ArrayIterator($this->paths);
+ }
+}