mirror/php-phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-07-30 21:40:43 +02:00
Code Issues Releases Wiki Activity

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

Browse Source 
PHPBB3-10323
This commit is contained in:
Nils Adermann
2011-08-31 17:49:48 -04:00
parent 52f5fa796f
commit 520a5f9295
13 changed files with 198 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
phpBB/includes/template/extension_path_provider.php Normal file
View File

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

74
phpBB/includes/template/path_provider.php
View File

@@ -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 $ext_dir_prefix = '';
protected $paths = array();
/**
* Constructor stores extension manager
*
* @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
* 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)
{
$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 = current($this->templates);
$this->items = $this->find();
$this->main_template_path = $this->paths[0];
}
/**
@@ -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);
}
}

52
phpBB/includes/template/path_provider_interface.php Normal file
View File

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

2
phpBB/includes/template/template.php
View File

@@ -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;