diff options
| author | Oleg Pudeyev <oleg@bsdpower.com> | 2010-04-17 03:13:30 -0400 |
|---|---|---|
| committer | Oleg Pudeyev <oleg@bsdpower.com> | 2011-02-12 22:05:49 -0500 |
| commit | 0f9b3bcc27e7daf7d605a7a38310a8f62b9a76e8 (patch) | |
| tree | 15cacd0d8bc8a28bbf1cc73504e7f7f61803a987 /phpBB/includes/cron/cron_task_base.php | |
| parent | 61e0285da86ffaf825cfcd486b5372b9566e51d7 (diff) | |
| download | forums-0f9b3bcc27e7daf7d605a7a38310a8f62b9a76e8.tar forums-0f9b3bcc27e7daf7d605a7a38310a8f62b9a76e8.tar.gz forums-0f9b3bcc27e7daf7d605a7a38310a8f62b9a76e8.tar.bz2 forums-0f9b3bcc27e7daf7d605a7a38310a8f62b9a76e8.tar.xz forums-0f9b3bcc27e7daf7d605a7a38310a8f62b9a76e8.zip | |
[feature/system-cron] Refactored cron task naming, loading and running.
PHPBB3-9596
Diffstat (limited to 'phpBB/includes/cron/cron_task_base.php')
| -rw-r--r-- | phpBB/includes/cron/cron_task_base.php | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/phpBB/includes/cron/cron_task_base.php b/phpBB/includes/cron/cron_task_base.php new file mode 100644 index 0000000000..f66894e7b2 --- /dev/null +++ b/phpBB/includes/cron/cron_task_base.php @@ -0,0 +1,64 @@ +<?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 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. +* +* @package phpBB3 +*/ +abstract class cron_task_base +{ + /** + * Runs this cron task. + */ + abstract 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. + */ + public function is_runnable() + { + return true; + } + + /** + * Returns whether this cron task should run now, because enough time + * has passed since it was last run. + */ + public function should_run() + { + return true; + } + + /** + * Returns whether this cron task can be run in shutdown function. + */ + public function is_shutdown_function_safe() + { + return true; + } +} |