aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/phpbb/cron/task/task.php
diff options
context:
space:
mode:
authorMarc Alexander <admin@m-a-styles.de>2013-07-14 16:51:46 -0400
committerMarc Alexander <admin@m-a-styles.de>2013-07-14 16:51:46 -0400
commitbc6122b64ffb5c13c26991f78346fdc7dee6f9f0 (patch)
tree31673423cd6ab751bc8b102c97e89a182a94e219 /phpBB/phpbb/cron/task/task.php
parent79dd44061bbfeab64dd2ff7b40541612c219c33c (diff)
parent1891e24ea6f5b8d5944535479182e70119b2979f (diff)
downloadforums-bc6122b64ffb5c13c26991f78346fdc7dee6f9f0.tar
forums-bc6122b64ffb5c13c26991f78346fdc7dee6f9f0.tar.gz
forums-bc6122b64ffb5c13c26991f78346fdc7dee6f9f0.tar.bz2
forums-bc6122b64ffb5c13c26991f78346fdc7dee6f9f0.tar.xz
forums-bc6122b64ffb5c13c26991f78346fdc7dee6f9f0.zip
Merge branch 'develop' of https://github.com/phpbb/phpbb3 into ticket/11531
Diffstat (limited to 'phpBB/phpbb/cron/task/task.php')
-rw-r--r--phpBB/phpbb/cron/task/task.php55
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();
+}