public static function BackdropQueue::get

1 system.queue.inc public static BackdropQueue::get($name, $reliable = FALSE)

Returns the queue object for a given name.

The following can be set in settings.php through the $settings variable:

queue_class_$name: the class to be used for the queue $name.
queue_default_class: the class to use when queue_class_$name is not defined. Defaults to SystemQueue, a reliable backend using SQL.
queue_default_reliable_class: the class to use when queue_class_$name is not defined and the queue_default_class is not reliable. Defaults to SystemQueue.

Parameters

$name: Arbitrary string. The name of the queue to work with.

$reliable: TRUE if the ordering of items and guaranteeing every item executes at least once is important, FALSE if scalability is the main concern.

Return value

BackdropQueueInterface: The queue object for a given name.

19 calls to BackdropQueue::get()

backdrop_cron_run in core/includes/common.inc: Executes a cron run when called.
CronQueueTestCase::testCallable in core/modules/system/tests/system.test: Tests worker defined as a class method callable.
CronQueueTestCase::testExceptions in core/modules/system/tests/system.test: Tests that exceptions thrown by workers are handled properly.
cron_example_add_jobs_to_queue in modules/examples/cron_example/cron_example.module: Submit function used to add the items to the queue.
cron_example_form in modules/examples/cron_example/cron_example.module: The form to provide a link to cron.php.

... See full list

File

core/modules/system/system.queue.inc, line 79: Queue functionality.

Class

BackdropQueue: Factory class for interacting with queues.

Code

public static function get($name, $reliable = FALSE) {
  static $queues;
  if (!isset($queues[$name])) {
    $class = settings_get('queue_class_' . $name, NULL);
    if (!$class) {
      $class = settings_get('queue_default_class', 'SystemQueue');
    }
    $object = new $class($name);
    if ($reliable && !$object instanceof BackdropReliableQueueInterface) {
      $class = settings_get('queue_default_reliable_class', 'SystemQueue');
      $object = new $class($name);
    }
    $queues[$name] = $object;
  }
  return $queues[$name];
}