aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/includes/cron/cron_task_wrapper.php
blob: 3919e4f04906a567b6eaca00340878be1c020c0a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
<?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 cron_task_wrapper
{
	public function __construct($task)
	{
		$this->task = $task;
	}

	/**
	* 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.
	*/
	public function get_name()
	{
		$class = get_class($this->task);
		return preg_replace('/^cron_task_/', '', $class);
	}

	public function get_url()
	{
		global $phpbb_root_path, $phpEx;

		$name = $this->get_name();
		$url = append_sid($phpbb_root_path . 'cron.' . $phpEx, 'cron_type=' . $name);
		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);
	}
}