diff options
Diffstat (limited to 'phpBB/includes/cron/task/parametrized.php')
| -rw-r--r-- | phpBB/includes/cron/task/parametrized.php | 52 | 
1 files changed, 52 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..c6c45be0c0 --- /dev/null +++ b/phpBB/includes/cron/task/parametrized.php @@ -0,0 +1,52 @@ +<?php +/** +* +* @package phpBB3 +* @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. +	* +	* @return array +	*/ +	public function get_parameters(); + +	/** +	* Parses parameters found in $request, which is an instance of +	* phpbb_request_interface. +	* +	* $request contains user input and must not be trusted. +	* Cron task must validate all data before using it. +	* +	* @param phpbb_request_interface $request Request object. +	* +	* @return void +	*/ +	public function parse_parameters(phpbb_request_interface $request); +} | 
