diff options
| author | Oleg Pudeyev <oleg@bsdpower.com> | 2010-04-17 06:32:15 -0400 |
|---|---|---|
| committer | Oleg Pudeyev <oleg@bsdpower.com> | 2011-02-12 22:05:49 -0500 |
| commit | 0cfbdcc7449f1cc17b819ffe49aec88c274dd090 (patch) | |
| tree | f154c14e3b56a96e20427676c3ae40cf656be11a /phpBB/includes/cron/cron_task.php | |
| parent | 0f9b3bcc27e7daf7d605a7a38310a8f62b9a76e8 (diff) | |
| download | forums-0cfbdcc7449f1cc17b819ffe49aec88c274dd090.tar forums-0cfbdcc7449f1cc17b819ffe49aec88c274dd090.tar.gz forums-0cfbdcc7449f1cc17b819ffe49aec88c274dd090.tar.bz2 forums-0cfbdcc7449f1cc17b819ffe49aec88c274dd090.tar.xz forums-0cfbdcc7449f1cc17b819ffe49aec88c274dd090.zip | |
[feature/system-cron] Reorganized cron task parametrization.
PHPBB3-9596
Diffstat (limited to 'phpBB/includes/cron/cron_task.php')
| -rw-r--r-- | phpBB/includes/cron/cron_task.php | 26 |
1 files changed, 23 insertions, 3 deletions
diff --git a/phpBB/includes/cron/cron_task.php b/phpBB/includes/cron/cron_task.php index 8b9ffacae6..46eacff517 100644 --- a/phpBB/includes/cron/cron_task.php +++ b/phpBB/includes/cron/cron_task.php @@ -48,13 +48,33 @@ interface cron_task } /** -* Parametrized cron task interface +* 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 parametrized_cron_task extends cron_task { /** - * Returns parameters of this cron task as a query string. + * 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 get_url_query_string(); + public function parse_parameters($params); } |