* @license GNU General Public License, version 2 (GPL-2.0) * * For full copyright and license information, please see * the docs/CREDITS.txt file. * */ namespace phpbb\cron\task; /** * Cron task wrapper class. * Enhances cron tasks with convenience methods that work identically for all tasks. */ class wrapper { protected $task; protected $phpbb_root_path; protected $php_ext; /** * Constructor. * * Wraps a task $task, which must implement cron_task interface. * * @param \phpbb\cron\task\task $task The cron task to wrap. */ public function __construct(\phpbb\cron\task\task $task, $phpbb_root_path, $php_ext) { $this->task = $task; $this->phpbb_root_path = $phpbb_root_path; $this->php_ext = $php_ext; } /** * Returns whether the wrapped task is parametrised. * * Parametrized tasks accept parameters during initialization and must * normally be scheduled with parameters. * * @return bool Whether or not this task is parametrized. */ 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. * * @return bool Whether the wrapped task is ready to run. */ public function is_ready() { return $this->task->is_runnable() && $this->task->should_run(); } /** * Returns a url through which this task may be invoked via web. * * When system cron is not in use, running a cron task is accomplished * by outputting an image with the url returned by this function as * source. * * @return string URL through which this task may be invoked. */ public function get_url() { $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($this->phpbb_root_path . 'cron.' . $this->php_ext, 'cron_type=' . $name . $extra); return $url; } /** * Forwards all other method calls to the wrapped task implementation. * * @return mixed */ public function __call($name, $args) { return call_user_func_array(array($this->task, $name), $args); } } b6887e81c0'>test_framework
diff options
context:
space:
mode:
authorAndreas Fischer <bantu@phpbb.com>2014-09-12 00:54:51 +0200
committerAndreas Fischer <bantu@phpbb.com>2014-09-12 00:54:51 +0200
commitf26b6b6251447eb66748ec14dea826b6887e81c0 (patch)
treed555ae60a7720103d02f9843e6f7befb52dc407f /tests/test_framework
parentf892646a8451d5ecf93d6edce55b17e4620acb18 (diff)
parentfcd2a2f186641f0c11abc40e196e6d916c87646c (diff)
downloadforums-f26b6b6251447eb66748ec14dea826b6887e81c0.tar
forums-f26b6b6251447eb66748ec14dea826b6887e81c0.tar.gz
forums-f26b6b6251447eb66748ec14dea826b6887e81c0.tar.bz2
forums-f26b6b6251447eb66748ec14dea826b6887e81c0.tar.xz
forums-f26b6b6251447eb66748ec14dea826b6887e81c0.zip
Merge pull request #2941 from Senky/ticket/12734