aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/includes/style/path_provider_interface.php
diff options
context:
space:
mode:
authorVjacheslav Trushkin <arty@phpbb.com>2012-03-14 22:57:58 +0200
committerVjacheslav Trushkin <arty@phpbb.com>2012-03-14 22:57:58 +0200
commit7d414d04ca80b3dc5efc7ece4c3c28123a4e7e89 (patch)
treef2a339953921dcee79c0d86f4e4ed47c72b0f6a9 /phpBB/includes/style/path_provider_interface.php
parent7dfb8d7c2022669087b3ed0ba7871b8346e5a6dd (diff)
downloadforums-7d414d04ca80b3dc5efc7ece4c3c28123a4e7e89.tar
forums-7d414d04ca80b3dc5efc7ece4c3c28123a4e7e89.tar.gz
forums-7d414d04ca80b3dc5efc7ece4c3c28123a4e7e89.tar.bz2
forums-7d414d04ca80b3dc5efc7ece4c3c28123a4e7e89.tar.xz
forums-7d414d04ca80b3dc5efc7ece4c3c28123a4e7e89.zip
[feature/merging-style-components] Moving template classes to style
Moving includes/template/ to includes/style/, adding template_ prefix to classes that deal only with templates PHPBB3-10632
Diffstat (limited to 'phpBB/includes/style/path_provider_interface.php')
-rw-r--r--phpBB/includes/style/path_provider_interface.php54
1 files changed, 54 insertions, 0 deletions
diff --git a/phpBB/includes/style/path_provider_interface.php b/phpBB/includes/style/path_provider_interface.php
new file mode 100644
index 0000000000..8b3a406d2a
--- /dev/null
+++ b/phpBB/includes/style/path_provider_interface.php
@@ -0,0 +1,54 @@
+<?php
+/**
+*
+* @package phpBB3
+* @copyright (c) 2011 phpBB Group
+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+*
+*/
+
+/**
+* @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.
+ * @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);
+
+ /**
+ * Retrieves the path to the main template passed into set_templates()
+ *
+ * @return string Main template path
+ */
+ public function get_main_template_path();
+}