diff options
| author | David King <imkingdavid@gmail.com> | 2013-08-31 13:37:11 -0700 |
|---|---|---|
| committer | David King <imkingdavid@gmail.com> | 2013-08-31 13:37:11 -0700 |
| commit | af1eb7466f11cdb0f851acfcacd957267e20e3ce (patch) | |
| tree | 1c72f7436ffcaa0d355ee11a0375323dcf5731f6 /phpBB/phpbb/cron/task/task.php | |
| parent | 9485eea0987478da25327a06a4fd36943ca1c01c (diff) | |
| parent | 9d6370751f1b998e3da448e16c1446b33ddd17d0 (diff) | |
| download | forums-af1eb7466f11cdb0f851acfcacd957267e20e3ce.tar forums-af1eb7466f11cdb0f851acfcacd957267e20e3ce.tar.gz forums-af1eb7466f11cdb0f851acfcacd957267e20e3ce.tar.bz2 forums-af1eb7466f11cdb0f851acfcacd957267e20e3ce.tar.xz forums-af1eb7466f11cdb0f851acfcacd957267e20e3ce.zip | |
Merge branch 'develop' into ticket/11215
Diffstat (limited to 'phpBB/phpbb/cron/task/task.php')
| -rw-r--r-- | phpBB/phpbb/cron/task/task.php | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/phpBB/phpbb/cron/task/task.php b/phpBB/phpbb/cron/task/task.php new file mode 100644 index 0000000000..2d585df96d --- /dev/null +++ b/phpBB/phpbb/cron/task/task.php @@ -0,0 +1,55 @@ +<?php +/** +* +* @package phpBB3 +* @copyright (c) 2010 phpBB Group +* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2 +* +*/ + +/** +* @ignore +*/ +if (!defined('IN_PHPBB')) +{ + exit; +} + +/** +* Cron task interface +* @package phpBB3 +*/ +interface phpbb_cron_task +{ + /** + * Returns the name of the task. + * + * @return string Name of wrapped task. + */ + public function get_name(); + + /** + * Runs this cron task. + * + * @return null + */ + public function run(); + + /** + * 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(); + + /** + * Returns whether this cron task should run now, because enough time + * has passed since it was last run. + * + * @return bool + */ + public function should_run(); +} |