/**
* 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' => 'SqlParallel']
+ * 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];
+ $params = array_merge($defaults, $params, ['name' => $name]);
+ return CRM_Queue_Service::singleton()->create($params);
}
/**