Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
Total | |
100.00% |
1 / 1 |
|
100.00% |
4 / 4 |
CRAP | |
100.00% |
5 / 5 |
base | |
100.00% |
1 / 1 |
|
100.00% |
4 / 4 |
4 | |
100.00% |
5 / 5 |
get_name | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
set_name | |
100.00% |
1 / 1 |
1 | |
100.00% |
2 / 2 |
|||
is_runnable | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
should_run | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
<?php | |
/** | |
* | |
* This file is part of the phpBB Forum Software package. | |
* | |
* @copyright (c) phpBB Limited <https://www.phpbb.com> | |
* @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 base class. Provides sensible defaults for cron tasks | |
* and partially implements cron task interface, making writing cron tasks easier. | |
* | |
* At a minimum, subclasses must override the run() method. | |
* | |
* Cron tasks need not inherit from this base class. If desired, | |
* they may implement cron task interface directly. | |
*/ | |
abstract class base implements \phpbb\cron\task\task | |
{ | |
private $name; | |
/** | |
* Returns the name of the task. | |
* | |
* @return string Name of wrapped task. | |
*/ | |
public function get_name() | |
{ | |
return $this->name; | |
} | |
/** | |
* Sets the name of the task. | |
* | |
* @param string $name The task name | |
*/ | |
public function set_name($name) | |
{ | |
$this->name = $name; | |
} | |
/** | |
* Returns whether this cron task can run, given current board configuration. | |
* | |
* For example, a cron task that prunes forums can only run when | |
* forum pruning is enabled. | |
* | |
* @return bool | |
*/ | |
public function is_runnable() | |
{ | |
return true; | |
} | |
/** | |
* Returns whether this cron task should run now, because enough time | |
* has passed since it was last run. | |
* | |
* @return bool | |
*/ | |
public function should_run() | |
{ | |
return true; | |
} | |
} |