aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--phpBB/includes/cron/provider.php50
-rw-r--r--phpBB/includes/extension/provider.php65
-rw-r--r--tests/cron/provider_test.php4
3 files changed, 70 insertions, 49 deletions
diff --git a/phpBB/includes/cron/provider.php b/phpBB/includes/cron/provider.php
index ee0f93a308..42552e1d8e 100644
--- a/phpBB/includes/cron/provider.php
+++ b/phpBB/includes/cron/provider.php
@@ -22,52 +22,20 @@ if (!defined('IN_PHPBB'))
*
* @package phpBB3
*/
-class phpbb_cron_provider implements IteratorAggregate
+class phpbb_cron_provider extends phpbb_extension_provider
{
/**
- * Array holding all found task class names.
- *
- * @var array
- */
- protected $task_names = array();
-
- /**
- * An extension manager to search for cron tasks in extensions.
- * @var phpbb_extension_manager
- */
- protected $extension_manager;
-
- /**
- * Constructor. Loads all available tasks.
- *
- * Tasks will be looked up in the core task directory located in
- * includes/cron/task/core/ and in extensions. Task classes will be
- * autoloaded and must be named according to autoloading naming conventions.
- *
- * Tasks in extensions must be located in a directory called cron or a subdir
- * of a directory called cron. The class and filename must end in a _task
- * suffix.
- *
- * @param phpbb_extension_manager $extension_manager phpBB extension manager
- */
- public function __construct(phpbb_extension_manager $extension_manager)
- {
- $this->extension_manager = $extension_manager;
-
- $this->task_names = $this->find_cron_task_names();
- }
-
- /**
* Finds cron task names using the extension manager.
*
* All PHP files in includes/cron/task/core/ are considered tasks. Tasks
* in extensions have to be located in a directory called cron or a subdir
* of a directory called cron. The class and filename must end in a _task
- * suffix.
+ * suffix. Additionally all PHP files in includes/cron/task/core/ are
+ * tasks.
*
* @return array List of task names
*/
- public function find_cron_task_names()
+ public function find()
{
$finder = $this->extension_manager->get_finder();
@@ -79,14 +47,4 @@ class phpbb_cron_provider implements IteratorAggregate
->default_directory('')
->get_classes();
}
-
- /**
- * Retrieve an iterator over all task names
- *
- * @return ArrayIterator An iterator for the array of task names
- */
- public function getIterator()
- {
- return new ArrayIterator($this->task_names);
- }
}
diff --git a/phpBB/includes/extension/provider.php b/phpBB/includes/extension/provider.php
new file mode 100644
index 0000000000..9b5ec56d30
--- /dev/null
+++ b/phpBB/includes/extension/provider.php
@@ -0,0 +1,65 @@
+<?php
+/**
+*
+* @package extension
+* @copyright (c) 2011 phpBB Group
+* @license http://opensource.org/licenses/gpl-license.php GNU Public License
+*
+*/
+
+/**
+* @ignore
+*/
+if (!defined('IN_PHPBB'))
+{
+ exit;
+}
+
+/**
+* Provides a set of items found in extensions
+*
+* @package extension
+*/
+abstract class phpbb_extension_provider implements IteratorAggregate
+{
+ /**
+ * Array holding all found items
+ * @var array
+ */
+ protected $items = array();
+
+ /**
+ * An extension manager to search for items in extensions
+ * @var phpbb_extension_manager
+ */
+ protected $extension_manager;
+
+ /**
+ * Constructor. Loads all available items.
+ *
+ * @param phpbb_extension_manager $extension_manager phpBB extension manager
+ */
+ public function __construct(phpbb_extension_manager $extension_manager)
+ {
+ $this->extension_manager = $extension_manager;
+
+ $this->items = $this->find();
+ }
+
+ /**
+ * Finds template paths using the extension manager.
+ *
+ * @return array List of task names
+ */
+ abstract function find();
+
+ /**
+ * Retrieve an iterator over all items
+ *
+ * @return ArrayIterator An iterator for the array of template paths
+ */
+ public function getIterator()
+ {
+ return new ArrayIterator($this->items);
+ }
+}
diff --git a/tests/cron/provider_test.php b/tests/cron/provider_test.php
index 781425e6ab..3a0545ffc6 100644
--- a/tests/cron/provider_test.php
+++ b/tests/cron/provider_test.php
@@ -27,10 +27,8 @@ class phpbb_cron_provider_test extends PHPUnit_Framework_TestCase
public function test_manager_finds_shipped_tasks()
{
- $task_iterator = $this->provider->find_cron_task_names();
-
$tasks = array();
- foreach ($task_iterator as $task)
+ foreach ($this->provider as $task)
{
$tasks[] = $task;
}