1 files changed, 49 insertions, 0 deletions
diff --git a/phpBB/includes/cron/task/parametrized.php b/phpBB/includes/cron/task/parametrized.php
new file mode 100644
index 0000000000..d505cc3328
--- /dev/null
+++ b/phpBB/includes/cron/task/parametrized.php
@@ -0,0 +1,49 @@
+<?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;
+}
+
+/**
+* Parametrized cron task interface.
+*
+* Parametrized cron tasks are somewhat of a cross between regular cron tasks and
+* delayed jobs. Whereas regular cron tasks perform some action globally,
+* parametrized cron tasks perform actions on a particular object (or objects).
+* Parametrized cron tasks do not make sense and are not usable without
+* specifying these objects.
+*
+* @package phpBB3
+*/
+interface phpbb_cron_task_parametrized extends phpbb_cron_task
+{
+	/**
+	* Returns parameters of this cron task as an array.
+	*
+	* The array must map string keys to string values.
+	*/
+	public function get_parameters();
+
+	/**
+	* Parses parameters found in $params, which is an array.
+	*
+	* $params contains user input and must not be trusted.
+	* In normal operation $params contains the same data that was returned by
+	* get_parameters method. However, a malicious user can supply arbitrary
+	* data in $params.
+	* Cron task must validate all keys and values in $params before using them.
+	*/
+	public function parse_parameters($params);
+}
+\ No newline at end of file