diff options
| author | Andy Chase <asperous2@gmail.com> | 2013-07-22 11:29:36 -0700 |
|---|---|---|
| committer | Andy Chase <asperous2@gmail.com> | 2013-07-22 11:29:36 -0700 |
| commit | e2a769ac79ad408e94935c97a5fc1325fb838c4f (patch) | |
| tree | 5f56bbc9d9290f49a6c88987561f345df49f8a3c /phpBB/phpbb/cron/task/base.php | |
| parent | cc1aef47fb4f5d37415436c62067ad2dcde768bb (diff) | |
| parent | b71038486e067daf0c608d73aabeb60a56e86840 (diff) | |
| download | forums-e2a769ac79ad408e94935c97a5fc1325fb838c4f.tar forums-e2a769ac79ad408e94935c97a5fc1325fb838c4f.tar.gz forums-e2a769ac79ad408e94935c97a5fc1325fb838c4f.tar.bz2 forums-e2a769ac79ad408e94935c97a5fc1325fb838c4f.tar.xz forums-e2a769ac79ad408e94935c97a5fc1325fb838c4f.zip | |
Merge branch 'develop' into ticket/11620
Diffstat (limited to 'phpBB/phpbb/cron/task/base.php')
| -rw-r--r-- | phpBB/phpbb/cron/task/base.php | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/phpBB/phpbb/cron/task/base.php b/phpBB/phpbb/cron/task/base.php new file mode 100644 index 0000000000..94a2f267b4 --- /dev/null +++ b/phpBB/phpbb/cron/task/base.php @@ -0,0 +1,76 @@ +<?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 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 phpbb_cron_task_base implements phpbb_cron_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; + } +} |