[feature/extension-manager] Refactoring the structure of extension provider

PHPBB3-10323

phpBB/common.php

@@ -131,7 +131,7 @@ set_config_count(null, null, null, $config);
 $phpbb_extension_manager = new phpbb_extension_manager($db, EXT_TABLE, $phpbb_root_path, ".$phpEx", $cache->get_driver());
 
 $phpbb_template_locator = new phpbb_template_locator();
-$phpbb_template_path_provider = new phpbb_template_path_provider($phpbb_extension_manager);
+$phpbb_template_path_provider = new phpbb_template_extension_path_provider($phpbb_extension_manager, new phpbb_template_path_provider());
 $template = new phpbb_template($phpbb_root_path, $phpEx, $config, $user, $phpbb_template_locator, $phpbb_template_path_provider);
 
 // Add own hook handler
@@ -145,5 +145,5 @@ foreach ($cache->obtain_hooks() as $hook)
 
 if (!$config['use_system_cron'])
 {
-	$cron = new phpbb_cron_manager(new phpbb_cron_provider($phpbb_extension_manager), $cache->get_driver());
+	$cron = new phpbb_cron_manager(new phpbb_cron_task_provider($phpbb_extension_manager), $cache->get_driver());
 }

phpBB/cron.php

@@ -62,7 +62,7 @@ function do_cron($cron_lock, $run_tasks)
 
 if ($config['use_system_cron'])
 {
-	$cron = new phpbb_cron_manager(new phpbb_cron_provider($phpbb_extension_manager), $cache->get_driver());
+	$cron = new phpbb_cron_manager(new phpbb_cron_task_provider($phpbb_extension_manager), $cache->get_driver());
 }
 else
 {

phpBB/includes/bbcode.php

@@ -134,7 +134,7 @@ class bbcode
 			$this->template_bitfield = new bitfield($user->theme['bbcode_bitfield']);
 
 			$template_locator = new phpbb_template_locator();
-			$template_path_provider = new phpbb_template_path_provider($phpbb_extension_manager);
+			$template_path_provider = new phpbb_template_extension_path_provider($phpbb_extension_manager, new phpbb_template_path_provider());
 			$template = new phpbb_template($phpbb_root_path, $phpEx, $config, $user, $template_locator, $template_path_provider);
 			$template->set_template();
 			$template_locator->set_filenames(array('bbcode.html' => 'bbcode.html'));

phpBB/includes/cron/task/provider.php

@@ -22,7 +22,7 @@ if (!defined('IN_PHPBB'))
 *
 * @package phpBB3
 */
-class phpbb_cron_provider extends phpbb_extension_provider
+class phpbb_cron_task_provider extends phpbb_extension_provider
 {
 	/**
 	* Finds cron task names using the extension manager.
@@ -35,7 +35,7 @@ class phpbb_cron_provider extends phpbb_extension_provider
 	*
 	* @return array     List of task names
 	*/
-	public function find()
+	protected function find()
 	{
 		$finder = $this->extension_manager->get_finder();
 

phpBB/includes/extension/provider.php

@@ -24,9 +24,9 @@ abstract class phpbb_extension_provider implements IteratorAggregate
 {
 	/**
 	* Array holding all found items
-	* @var array
+	* @var array|null
 	*/
-	protected $items = array();
+	protected $items = null;
 
 	/**
 	* An extension manager to search for items in extensions
@@ -42,8 +42,6 @@ abstract class phpbb_extension_provider implements IteratorAggregate
 	public function __construct(phpbb_extension_manager $extension_manager)
 	{
 		$this->extension_manager = $extension_manager;
-
-		$this->items = $this->find();
 	}
 
 	/**
@@ -51,7 +49,7 @@ abstract class phpbb_extension_provider implements IteratorAggregate
 	*
 	* @return array     List of task names
 	*/
-	abstract function find();
+	abstract protected function find();
 
 	/**
 	* Retrieve an iterator over all items
@@ -60,6 +58,11 @@ abstract class phpbb_extension_provider implements IteratorAggregate
 	*/
 	public function getIterator()
 	{
+		if ($this->items === null)
+		{
+			$this->items = $this->find();
+		}
+
 		return new ArrayIterator($this->items);
 	}
 }

phpBB/includes/functions_messenger.php

@@ -194,7 +194,7 @@ class messenger
 		if (!isset($this->tpl_msg[$template_lang . $template_file]))
 		{
 			$template_locator = new phpbb_template_locator();
-			$template_path_provider = new phpbb_template_path_provider($phpbb_extension_manager);
+			$template_path_provider = new phpbb_template_extension_path_provider($phpbb_extension_manager, new phpbb_template_path_provider());
 			$this->tpl_msg[$template_lang . $template_file] = new phpbb_template($phpbb_root_path, $phpEx, $config, $user, $template_locator, $template_path_provider);
 			$tpl = &$this->tpl_msg[$template_lang . $template_file];
 

phpBB/includes/template/extension_path_provider.php

@@ -0,0 +1,110 @@
+<?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 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
+{
+	protected $ext_dir_prefix = '';
+	protected $base_paths;
+
+	/**
+	* Constructor stores extension manager
+	*
+	* @param phpbb_extension_manager $extension_manager phpBB extension manager
+	* @param phpbb_template_path_provider $base_paths 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)
+	{
+		parent::__construct($extension_manager);
+		$this->base_paths = $base_paths;
+	}
+
+	/**
+	* 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)
+	{
+		$this->ext_dir_prefix = $ext_dir_prefix;
+	}
+
+	/**
+	* 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.
+	*
+	* @return array     List of template paths
+	*/
+	public function find()
+	{
+		$directories = array();
+
+		$finder = $this->extension_manager->get_finder();
+		foreach ($this->base_paths as $path)
+		{
+			if ($path && !phpbb_is_absolute($path))
+			{
+				$directories = array_merge($directories, $finder
+					->directory('/' . $this->ext_dir_prefix . $path)
+					->get_directories()
+				);
+			}
+		}
+
+		foreach ($this->base_paths 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.
+	* @return null
+	*/
+	public function set_templates(array $templates)
+	{
+		$this->base_paths->set_templates($templates);
+	}
+
+	/**
+	* 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_paths->get_main_template_path();
+	}
+}

phpBB/includes/template/path_provider.php

@@ -22,68 +22,19 @@ if (!defined('IN_PHPBB'))
 *
 * @package phpBB3
 */
-class phpbb_template_path_provider extends phpbb_extension_provider
+class phpbb_template_path_provider implements IteratorAggregate, phpbb_template_path_provider_interface
 {
 	protected $main_template_name = '';
-	protected $templates = array();
+	protected $paths = array();
-	protected $ext_dir_prefix = '';
 
 	/**
-	* Constructor stores extension manager
+	* Ignores the extension dir prefix
-	*
-	* @param phpbb_extension_manager $extension_manager phpBB extension manager
-	*/
-	public function __construct(phpbb_extension_manager $extension_manager = null)
-	{
-		// no super call to avoid find() call
-		$this->extension_manager = $extension_manager;
-	}
-
-	/**
-	* 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)
 	{
-		$this->ext_dir_prefix = $ext_dir_prefix;
-	}
-
-	/**
-	* 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.
-	*
-	* @return array     List of template paths
-	*/
-	public function find()
-	{
-		$directories = array();
-
-		if ($this->extension_manager)
-		{
-			$finder = $this->extension_manager->get_finder();
-			foreach ($this->templates as $name => $path)
-			{
-				if ($path && !phpbb_is_absolute($path))
-				{
-					$directories = array_merge($directories, $finder
-						->directory('/' . $this->ext_dir_prefix . $path)
-						->get_directories()
-					);
-				}
-			}
-		}
-
-		foreach ($this->templates as $name => $path)
-		{
-			$directories[] = $path;
-		}
-
-		return $directories;
 	}
 
 	/**
@@ -97,7 +48,7 @@ class phpbb_template_path_provider extends phpbb_extension_provider
 	*/
 	public function set_templates(array $templates)
 	{
-		$this->templates = array();
+		$this->paths;
 
 		foreach ($templates as $name => $path)
 		{
@@ -106,13 +57,10 @@ class phpbb_template_path_provider extends phpbb_extension_provider
 				$path = $this->template_root_for_style($name);
 			}
 
-			$this->templates[$name] = $path;
+			$this->paths[] = $path;
 		}
 
-		reset($this->templates);
+		$this->main_template_path = $this->paths[0];
-		$this->main_template_path = current($this->templates);
-
-		$this->items = $this->find();
 	}
 
 	/**
@@ -136,4 +84,14 @@ class phpbb_template_path_provider extends phpbb_extension_provider
 	{
 		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);
+	}
 }

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();
+}

phpBB/includes/template/template.php

@@ -82,7 +82,7 @@ class phpbb_template
 	* @param phpbb_template_locator $locator template locator
 	* @param phpbb_template_path_provider $provider template path provider
 	*/
-	public function __construct($phpbb_root_path, $phpEx, $config, $user, phpbb_template_locator $locator, phpbb_template_path_provider $provider)
+	public function __construct($phpbb_root_path, $phpEx, $config, $user, phpbb_template_locator $locator, phpbb_template_path_provider_interface $provider)
 	{
 		$this->phpbb_root_path = $phpbb_root_path;
 		$this->phpEx = $phpEx;

tests/cron/task_provider_test.php

@@ -9,7 +9,7 @@
 
 require_once dirname(__FILE__) . '/../mock/extension_manager.php';
 
-class phpbb_cron_provider_test extends PHPUnit_Framework_TestCase
+class phpbb_cron_task_provider_test extends PHPUnit_Framework_TestCase
 {
 	public function setUp()
 	{
@@ -22,7 +22,7 @@ class phpbb_cron_provider_test extends PHPUnit_Framework_TestCase
 					'ext_path'      => 'ext/testext/'
 				),
 			));
-		$this->provider = new phpbb_cron_provider($this->extension_manager);
+		$this->provider = new phpbb_cron_task_provider($this->extension_manager);
 	}
 
 	public function test_manager_finds_shipped_tasks()

tests/template/template_inheritance_test.php

@@ -69,7 +69,7 @@ class phpbb_template_template_inheritance_test extends phpbb_template_template_t
 		$this->template_path = dirname(__FILE__) . '/templates';
 		$this->parent_template_path = dirname(__FILE__) . '/parent_templates';
 		$this->template_locator = new phpbb_template_locator();
-		$this->template_provider = new phpbb_template_path_provider(new phpbb_mock_extension_manager(dirname(__FILE__) . '/'));
+		$this->template_provider = new phpbb_template_path_provider();
 		$this->template = new phpbb_template($phpbb_root_path, $phpEx, $config, $user, $this->template_locator, $this->template_provider);
 		$this->template->set_custom_template($this->template_path, 'tests', $this->parent_template_path);
 	}

tests/template/template_test_case.php

@@ -59,7 +59,7 @@ class phpbb_template_template_test_case extends phpbb_test_case
 
 		$this->template_path = dirname(__FILE__) . '/templates';
 		$this->template_locator = new phpbb_template_locator();
-		$this->template_provider = new phpbb_template_path_provider(new phpbb_mock_extension_manager(dirname(__FILE__) . '/'));
+		$this->template_provider = new phpbb_template_path_provider();
 		$this->template = new phpbb_template($phpbb_root_path, $phpEx, $config, $user, $this->template_locator, $this->template_provider);
 		$this->template->set_custom_template($this->template_path, 'tests');
 	}