diff options
| author | Andy Chase <asperous2@gmail.com> | 2013-07-22 11:29:36 -0700 |
|---|---|---|
| committer | Andy Chase <asperous2@gmail.com> | 2013-07-22 11:29:36 -0700 |
| commit | e2a769ac79ad408e94935c97a5fc1325fb838c4f (patch) | |
| tree | 5f56bbc9d9290f49a6c88987561f345df49f8a3c /phpBB/phpbb/cron/task/parametrized.php | |
| parent | cc1aef47fb4f5d37415436c62067ad2dcde768bb (diff) | |
| parent | b71038486e067daf0c608d73aabeb60a56e86840 (diff) | |
| download | forums-e2a769ac79ad408e94935c97a5fc1325fb838c4f.tar forums-e2a769ac79ad408e94935c97a5fc1325fb838c4f.tar.gz forums-e2a769ac79ad408e94935c97a5fc1325fb838c4f.tar.bz2 forums-e2a769ac79ad408e94935c97a5fc1325fb838c4f.tar.xz forums-e2a769ac79ad408e94935c97a5fc1325fb838c4f.zip | |
Merge branch 'develop' into ticket/11620
Diffstat (limited to 'phpBB/phpbb/cron/task/parametrized.php')
| -rw-r--r-- | phpBB/phpbb/cron/task/parametrized.php | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/phpBB/phpbb/cron/task/parametrized.php b/phpBB/phpbb/cron/task/parametrized.php new file mode 100644 index 0000000000..5f0e46eafc --- /dev/null +++ b/phpBB/phpbb/cron/task/parametrized.php @@ -0,0 +1,52 @@ +<?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; +} + +/** +* 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 null + */ + public function parse_parameters(phpbb_request_interface $request); +} |