Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | n/a |
0 / 0 |
n/a |
0 / 0 |
CRAP | n/a |
0 / 0 |
|||
| 1 | <?php |
| 2 | /** |
| 3 | * |
| 4 | * This file is part of the phpBB Forum Software package. |
| 5 | * |
| 6 | * @copyright (c) phpBB Limited <https://www.phpbb.com> |
| 7 | * @license GNU General Public License, version 2 (GPL-2.0) |
| 8 | * |
| 9 | * For full copyright and license information, please see |
| 10 | * the docs/CREDITS.txt file. |
| 11 | * |
| 12 | */ |
| 13 | |
| 14 | namespace phpbb\cron\task; |
| 15 | |
| 16 | /** |
| 17 | * Cron task interface |
| 18 | */ |
| 19 | interface task |
| 20 | { |
| 21 | /** |
| 22 | * Returns the name of the task. |
| 23 | * |
| 24 | * @return string Name of wrapped task. |
| 25 | */ |
| 26 | public function get_name(); |
| 27 | |
| 28 | /** |
| 29 | * Runs this cron task. |
| 30 | * |
| 31 | * @return null |
| 32 | */ |
| 33 | public function run(); |
| 34 | |
| 35 | /** |
| 36 | * Returns whether this cron task can run, given current board configuration. |
| 37 | * |
| 38 | * For example, a cron task that prunes forums can only run when |
| 39 | * forum pruning is enabled. |
| 40 | * |
| 41 | * @return bool |
| 42 | */ |
| 43 | public function is_runnable(); |
| 44 | |
| 45 | /** |
| 46 | * Returns whether this cron task should run now, because enough time |
| 47 | * has passed since it was last run. |
| 48 | * |
| 49 | * @return bool |
| 50 | */ |
| 51 | public function should_run(); |
| 52 | } |