mirror of
https://github.com/phpbb/phpbb.git
synced 2025-02-26 21:13:50 +01:00
115 lines
2.4 KiB
PHP
115 lines
2.4 KiB
PHP
<?php
|
|
/**
|
|
*
|
|
* @package phpBB3
|
|
* @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
|
|
{
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* Wraps a task $task, which must implement cron_task interface.
|
|
*
|
|
* @param phpbb_cron_task $task The cron task to wrap.
|
|
*/
|
|
public function __construct(phpbb_cron_task $task)
|
|
{
|
|
$this->task = $task;
|
|
}
|
|
|
|
/**
|
|
* 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 the name of wrapped task. It is the same as the wrapped class's class name.
|
|
*
|
|
* @return string Class name of wrapped task.
|
|
*/
|
|
public function get_name()
|
|
{
|
|
return get_class($this->task);
|
|
}
|
|
|
|
/**
|
|
* 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()
|
|
{
|
|
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.
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function __call($name, $args)
|
|
{
|
|
return call_user_func_array(array($this->task, $name), $args);
|
|
}
|
|
}
|