From 0f9b3bcc27e7daf7d605a7a38310a8f62b9a76e8 Mon Sep 17 00:00:00 2001
From: Oleg Pudeyev <oleg@bsdpower.com>
Date: Sat, 17 Apr 2010 03:13:30 -0400
Subject: [feature/system-cron] Refactored cron task naming, loading and
 running.

PHPBB3-9596
---
 phpBB/includes/cron/cron_task.php | 60 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 phpBB/includes/cron/cron_task.php

(limited to 'phpBB/includes/cron/cron_task.php')

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();
+}
-- 
cgit v1.2.1