diff options
| author | Igor Wiedler <igor@wiedler.ch> | 2010-10-29 11:40:18 +0200 |
|---|---|---|
| committer | Oleg Pudeyev <oleg@bsdpower.com> | 2011-02-12 22:05:52 -0500 |
| commit | 132d2c2bd85bac6ed87ea3c57de27a9675192f29 (patch) | |
| tree | 56f6c4afd50300bd368ddd23b47e946d9a8f4316 /phpBB/includes/cron/task/wrapper.php | |
| parent | bd58fa49c000e99d049cbd96306315e1bd35b938 (diff) | |
| download | forums-132d2c2bd85bac6ed87ea3c57de27a9675192f29.tar forums-132d2c2bd85bac6ed87ea3c57de27a9675192f29.tar.gz forums-132d2c2bd85bac6ed87ea3c57de27a9675192f29.tar.bz2 forums-132d2c2bd85bac6ed87ea3c57de27a9675192f29.tar.xz forums-132d2c2bd85bac6ed87ea3c57de27a9675192f29.zip | |
[feature/system-cron] adjust some last filenames to make autoloading work
PHPBB3-9596
Diffstat (limited to 'phpBB/includes/cron/task/wrapper.php')
| -rw-r--r-- | phpBB/includes/cron/task/wrapper.php | 97 |
1 files changed, 97 insertions, 0 deletions
diff --git a/phpBB/includes/cron/task/wrapper.php b/phpBB/includes/cron/task/wrapper.php new file mode 100644 index 0000000000..e31f467cc8 --- /dev/null +++ b/phpBB/includes/cron/task/wrapper.php @@ -0,0 +1,97 @@ +<?php +/** +* +* @package phpBB3 +* @version $Id$ +* @copyright (c) 2010 phpBB Group +* @license http://opensource.org/licenses/gpl-license.php GNU Public License +* +*/ + +/** +* @ignore +*/ +if (!defined('IN_PHPBB')) +{ + exit; +} + +/** +* Cron task wrapper class. +* Enhances cron tasks with convenience methods that work identically for all tasks. +* +* @package phpBB3 +*/ +class phpbb_cron_task_wrapper +{ + /** + * Wraps a task $task, which must implement cron_task interface. + */ + public function __construct(phpbb_cron_task $task) + { + $this->task = $task; + } + + /** + * Returns whether this task is parametrized. + * + * Parametrized tasks accept parameters during initialization and must + * normally be scheduled with parameters. + */ + public function is_parametrized() + { + return $this->task instanceof phpbb_cron_task_parametrized; + } + + /** + * Returns whether the wrapped task is ready to run. + * + * A task is ready to run when it is runnable according to current configuration + * and enough time has passed since it was last run. + */ + public function is_ready() + { + return $this->task->is_runnable() && $this->task->should_run(); + } + + /** + * Returns the name of wrapped task. It is the same as the wrapped class's class name. + */ + public function get_name() + { + return get_class($this->task); + } + + /** + * Returns a url through which this task may be invoked via web. + */ + public function get_url() + { + global $phpbb_root_path, $phpEx; + + $name = $this->get_name(); + if ($this->is_parametrized()) + { + $params = $this->task->get_parameters(); + $extra = ''; + foreach ($params as $key => $value) + { + $extra .= '&' . $key . '=' . urlencode($value); + } + } + else + { + $extra = ''; + } + $url = append_sid($phpbb_root_path . 'cron.' . $phpEx, 'cron_type=' . $name . $extra); + return $url; + } + + /** + * Forwards all other method calls to the wrapped task implementation. + */ + public function __call($name, $args) + { + return call_user_func_array(array($this->task, $name), $args); + } +} |