public function CronQueueTestException::processItem in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/system/tests/modules/cron_queue_test/src/Plugin/QueueWorker/CronQueueTestException.php \Drupal\cron_queue_test\Plugin\QueueWorker\CronQueueTestException::processItem()

Works on a single queue item.

Parameters

mixed $data: The data that was passed to \Drupal\Core\Queue\QueueInterface::createItem() when the item was queued.

Throws

\Drupal\Core\Queue\RequeueException Processing is not yet finished. This will allow another process to claim the item immediately.

\Exception A QueueWorker plugin may throw an exception to indicate there was a problem. The cron process will log the exception, and leave the item in the queue to be processed again later.

\Drupal\Core\Queue\SuspendQueueException More specifically, a SuspendQueueException should be thrown when a QueueWorker plugin is aware that the problem will affect all subsequent workers of its queue. For example, a callback that makes HTTP requests may find that the remote server is not responding. The cron process will behave as with a normal Exception, and in addition will not attempt to process further items from the current item's queue during the current cron run.

Overrides QueueWorkerInterface::processItem

See also

\Drupal\Core\Cron::processQueues()

File

core/modules/system/tests/modules/cron_queue_test/src/Plugin/QueueWorker/CronQueueTestException.php, line 19

Class

CronQueueTestException

Plugin annotation @QueueWorker( id = "cron_queue_test_exception", title = @Translation("Exception test"), cron = {"time" = 1} )

Namespace

Drupal\cron_queue_test\Plugin\QueueWorker

Code

public function processItem($data) {
  $state = \Drupal::state();
  if (!$state
    ->get('cron_queue_test_exception')) {
    $state
      ->set('cron_queue_test_exception', 1);
    throw new \Exception('That is not supposed to happen.');
  }
  else {
    $state
      ->set('cron_queue_test_exception', 2);
  }
}