Merge pull request #24238 from demeritcowboy/boo

[civicrm-core.git] / Civi.php

diff --git a/Civi.php b/Civi.php
index d081572f992e8bde77fab68f07e5151b255b43e6..86e72ee847e75d959623c1e297267b3c9c55c3e7 100644 (file)
--- a/Civi.php
+++ b/Civi.php
@@ -108,18 +108,25 @@ class Civi {
   /**
    * Fetch a queue object.
    *
+   * Note: Historically, `CRM_Queue_Queue` objects were not persistently-registered. Persistence
+   * is now encouraged. This facade has a bias towards persistently-registered queues.
+   *
    * @param string $name
-   *   Name of the queue.
-   *   The queue must be persistent (stored in `civicrm_queue`).
+   *   The name of a persistent/registered queue (stored in `civicrm_queue`)
+   * @param array{type: string, is_autorun: bool, reset: bool, is_persistent: bool} $params
+   *   Specification for a queue.
+   *   This is not required for accessing an existing queue.
+   *   Specify this if you wish to auto-create the queue or to include advanced options (eg `reset`).
+   *   Example: ['type' => 'Sql', 'error' => 'abort']
+   *   Example: ['type' => 'SqlParallel', 'error' => 'delete']
+   *   Defaults: ['reset'=>FALSE, 'is_persistent'=>TRUE, 'is_autorun'=>FALSE]
    * @return \CRM_Queue_Queue
    * @see \CRM_Queue_Service
    */
-  public static function queue(string $name): CRM_Queue_Queue {
-    return CRM_Queue_Service::singleton()->create([
-      'name' => $name,
-      'reset' => FALSE,
-      'is_persistent' => TRUE,
-    ]);
+  public static function queue(string $name, array $params = []): CRM_Queue_Queue {
+    $defaults = ['reset' => FALSE, 'is_persistent' => TRUE, 'status' => 'active'];
+    $params = array_merge($defaults, $params, ['name' => $name]);
+    return CRM_Queue_Service::singleton()->create($params);
   }
 
   /**