aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/phpbb/cron/task/parametrized.php
diff options
context:
space:
mode:
authorNathan Guse <nathaniel.guse@gmail.com>2013-07-23 11:13:25 -0500
committerNathan Guse <nathaniel.guse@gmail.com>2013-07-23 11:13:25 -0500
commit485c6ab3553f518b157610ee1144bbcbef63f797 (patch)
tree0c50392c4716511e118eeabd3f48cceb3ac7e906 /phpBB/phpbb/cron/task/parametrized.php
parent41d8bfa974900c9befbde06cc08060eb8a552ec8 (diff)
parentbe59885d5fd4b44f1c43994dec928eda816f9ab8 (diff)
downloadforums-485c6ab3553f518b157610ee1144bbcbef63f797.tar
forums-485c6ab3553f518b157610ee1144bbcbef63f797.tar.gz
forums-485c6ab3553f518b157610ee1144bbcbef63f797.tar.bz2
forums-485c6ab3553f518b157610ee1144bbcbef63f797.tar.xz
forums-485c6ab3553f518b157610ee1144bbcbef63f797.zip
Merge branch 'develop' of github.com:phpbb/phpbb3 into ticket/11667
# By Joas Schilling (224) and others # Via Andreas Fischer (23) and others * 'develop' of github.com:phpbb/phpbb3: (385 commits) [ticket/11734] Readd accidently removed language strings of forum permissions [ticket/11620] Whitespace and combine function into test_case [ticket/11620] Move check_ban_test functions to setUp/tearDown for clarity [ticket/11620] Changed incorrect global variable [ticket/11620] Minor indentation changes and comment clarity [ticket/11733] Fix "Illegal offset type" Warning caused by overall feed [ticket/11733] Add browse test for feed.php [ticket/11731] Remove static calls to captcha garbage collector [ticket/11728] Replace topic_approved with topic_visibility [ticket/11620] Expected and actual test conditions wrongly swapped [ticket/11620] Space between . in directory import concatenation [ticket/11620] Changes to match merge [ticket/11620] Changes for code guidelines consistency [ticket/11620] Fix a static calls to non-static for session captcha [ticket/11620] Cleanup creation_test that was renamed on a cherry-pick [ticket/11620] Update auth_provider for new interface [ticket/11620] Added garbage_collection_test [ticket/11620] Fixed check_ban_test errors with cache and ban warning message [ticket/11620] Fixed a typo on check_ban_test [ticket/11620] Refactored check_isvalid_test to use session_test_case ...
Diffstat (limited to 'phpBB/phpbb/cron/task/parametrized.php')
-rw-r--r--phpBB/phpbb/cron/task/parametrized.php52
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);
+}