class CronQueueTestSuspendQueue

Same name and namespace in other branches
  1. 11.x core/modules/system/tests/modules/cron_queue_test/src/Plugin/QueueWorker/CronQueueTestSuspendQueue.php \Drupal\cron_queue_test\Plugin\QueueWorker\CronQueueTestSuspendQueue

A queue worker for testing suspending queue run.

Attributes

#[QueueWorker(id: self::PLUGIN_ID, title: new TranslatableMarkup('Suspend queue test'), cron: [ 'time' => 60, ])]

Hierarchy

Expanded class hierarchy of CronQueueTestSuspendQueue

1 file declares its use of CronQueueTestSuspendQueue
CronQueueTest.php in core/modules/system/tests/src/Kernel/System/CronQueueTest.php

File

core/modules/system/tests/modules/cron_queue_test/src/Plugin/QueueWorker/CronQueueTestSuspendQueue.php, line 13

Namespace

Drupal\cron_queue_test\Plugin\QueueWorker
View source
class CronQueueTestSuspendQueue extends QueueWorkerBase {
  
  /**
   * The plugin ID.
   */
  public const PLUGIN_ID = 'cron_queue_test_suspend';
  
  /**
   * {@inheritdoc}
   */
  public function processItem($data) {
    if ($data === 'suspend') {
      throw new SuspendQueueException('The queue is broken.');
    }
    // Do nothing otherwise.
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
CronQueueTestSuspendQueue::PLUGIN_ID public constant The plugin ID.
CronQueueTestSuspendQueue::processItem public function Works on a single queue item. Overrides QueueWorkerInterface::processItem
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin ID.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Gets the plugin ID of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 86

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.