aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/includes/cron/cron_task.php
diff options
context:
space:
mode:
Diffstat (limited to 'phpBB/includes/cron/cron_task.php')
-rw-r--r--phpBB/includes/cron/cron_task.php60
1 files changed, 60 insertions, 0 deletions
diff --git a/phpBB/includes/cron/cron_task.php b/phpBB/includes/cron/cron_task.php
new file mode 100644
index 0000000000..8b9ffacae6
--- /dev/null
+++ b/phpBB/includes/cron/cron_task.php
@@ -0,0 +1,60 @@
+<?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 interface
+* @package phpBB3
+*/
+interface cron_task
+{
+ /**
+ * Runs this cron task.
+ */
+ 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();
+
+ /**
+ * Returns whether this cron task should run now, because enough time
+ * has passed since it was last run.
+ */
+ public function should_run();
+
+ /**
+ * Returns whether this cron task can be run in shutdown function.
+ */
+ public function is_shutdown_function_safe();
+}
+
+/**
+* Parametrized cron task interface
+* @package phpBB3
+*/
+interface parametrized_cron_task extends cron_task
+{
+ /**
+ * Returns parameters of this cron task as a query string.
+ */
+ public function get_url_query_string();
+}