summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJennifer Hodgdon2015-04-13 14:39:41 (GMT)
committerJennifer Hodgdon2015-04-13 14:39:41 (GMT)
commita6512c8978132e06cf694f879f16e79cda8b17e1 (patch)
tree672235b143630a3a0ef388487d84a00d562931ef
parent95c294619dc466e3995c1e6d1f3b4e05287db900 (diff)
Issue #2296445 by Palashvijay4O, pjonckiere, er.pushpinderrana, roderik, blazey: Batch API: Overriding the queue class and name is not documented
-rw-r--r--core/includes/form.inc14
1 files changed, 14 insertions, 0 deletions
diff --git a/core/includes/form.inc b/core/includes/form.inc
index 2dbcdad..eb028e3 100644
--- a/core/includes/form.inc
+++ b/core/includes/form.inc
@@ -669,6 +669,20 @@ function template_preprocess_form_element_label(&$variables) {
* the batch.
* - safe_strings: Internal use only. Used to store and retrieve strings
* marked as safe between requests.
+ * - progressive: A Boolean that indicates whether or not the batch needs to
+ * run progressively. TRUE indicates that the batch will run in more than
+ * one run. FALSE (default) indicates that the batch will finish in a single
+ * run.
+ * - queue: An override of the default queue (with name and class fields
+ * optional). An array containing two elements:
+ * - name: Unique identifier for the queue.
+ * - class: The name of a class that implements
+ * \Drupal\Core\Queue\QueueInterface, including the full namespace but not
+ * starting with a backslash. It must have a constructor with two
+ * arguments: $name and a \Drupal\Core\Database\Connection object.
+ * Typically, the class will either be \Drupal\Core\Queue\Batch or
+ * \Drupal\Core\Queue\BatchMemory. Defaults to Batch if progressive is
+ * TRUE, or to BatchMemory if progressive is FALSE.
*/
function batch_set($batch_definition) {
if ($batch_definition) {