diff options
| author | Nils Adermann <naderman@naderman.de> | 2011-08-21 02:57:01 -0400 |
|---|---|---|
| committer | Nils Adermann <naderman@naderman.de> | 2011-09-29 15:42:46 +0200 |
| commit | 5d5030a48be3d65df85d78e26690085c0889c6e3 (patch) | |
| tree | a4b0f3dd7f551a5e37503698ee2ac0e52c177300 /phpBB/includes/cron/provider.php | |
| parent | 96209e022477d97b581b79cabace4caddd19501b (diff) | |
| download | forums-5d5030a48be3d65df85d78e26690085c0889c6e3.tar forums-5d5030a48be3d65df85d78e26690085c0889c6e3.tar.gz forums-5d5030a48be3d65df85d78e26690085c0889c6e3.tar.bz2 forums-5d5030a48be3d65df85d78e26690085c0889c6e3.tar.xz forums-5d5030a48be3d65df85d78e26690085c0889c6e3.zip | |
[feature/extension-manager] Remove cron's dependency on the extension manager.
Instead a separate cron provider supplies the manager with tasks from the
extension finder.
PHPBB3-10323
Diffstat (limited to 'phpBB/includes/cron/provider.php')
| -rw-r--r-- | phpBB/includes/cron/provider.php | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/phpBB/includes/cron/provider.php b/phpBB/includes/cron/provider.php new file mode 100644 index 0000000000..9936da3f55 --- /dev/null +++ b/phpBB/includes/cron/provider.php @@ -0,0 +1,92 @@ +<?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 cron manager with tasks +* +* Finds installed cron tasks and makes them available to the cron manager. +* +* @package phpBB3 +*/ +class phpbb_cron_provider implements \IteratorAggregate +{ + /** + * 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. + * + * @return array List of task names + */ + public function find_cron_task_names() + { + $finder = $this->extension_manager->get_finder(); + + return $finder + ->suffix('_task') + ->directory('/cron') + ->default_path('includes/cron/task/core/') + ->default_suffix('') + ->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); + } +} |