aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/includes/template/path_provider_interface.php
diff options
context:
space:
mode:
authorNils Adermann <naderman@naderman.de>2011-08-31 17:49:48 -0400
committerNils Adermann <naderman@naderman.de>2011-09-29 16:15:53 +0200
commit520a5f92953d350880355dbe46217d2b41edd2bd (patch)
treed0658eaf062ea332dd9be2a94ef5cb010fb35fd7 /phpBB/includes/template/path_provider_interface.php
parent52f5fa796f473e11a101b4da91e455bdc4839daf (diff)
downloadforums-520a5f92953d350880355dbe46217d2b41edd2bd.tar
forums-520a5f92953d350880355dbe46217d2b41edd2bd.tar.gz
forums-520a5f92953d350880355dbe46217d2b41edd2bd.tar.bz2
forums-520a5f92953d350880355dbe46217d2b41edd2bd.tar.xz
forums-520a5f92953d350880355dbe46217d2b41edd2bd.zip
[feature/extension-manager] Refactoring the structure of extension provider
PHPBB3-10323
Diffstat (limited to 'phpBB/includes/template/path_provider_interface.php')
-rw-r--r--phpBB/includes/template/path_provider_interface.php52
1 files changed, 52 insertions, 0 deletions
diff --git a/phpBB/includes/template/path_provider_interface.php b/phpBB/includes/template/path_provider_interface.php
new file mode 100644
index 0000000000..800d7697d9
--- /dev/null
+++ b/phpBB/includes/template/path_provider_interface.php
@@ -0,0 +1,52 @@
+<?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
+*/
+interface phpbb_template_path_provider_interface extends Traversable
+{
+ /**
+ * Defines a prefix to use for template paths in extensions
+ *
+ * @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
+ *
+ * @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.
+ * @return null
+ */
+ public function set_templates(array $templates);
+
+ /**
+ * Retrieves the path to the main template passed into set_templates()
+ *
+ * @return string Main template path
+ */
+ public function get_main_template_path();
+}