class CronQueueTestException

Same name and namespace in other branches
  1. 9 core/modules/system/tests/modules/cron_queue_test/src/Plugin/QueueWorker/CronQueueTestException.php \Drupal\cron_queue_test\Plugin\QueueWorker\CronQueueTestException
  2. 8.9.x core/modules/system/tests/modules/cron_queue_test/src/Plugin/QueueWorker/CronQueueTestException.php \Drupal\cron_queue_test\Plugin\QueueWorker\CronQueueTestException
  3. 11.x core/modules/system/tests/modules/cron_queue_test/src/Plugin/QueueWorker/CronQueueTestException.php \Drupal\cron_queue_test\Plugin\QueueWorker\CronQueueTestException

A queue worker for testing exceptions.

Attributes

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

Hierarchy

Expanded class hierarchy of CronQueueTestException

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

File

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

Namespace

Drupal\cron_queue_test\Plugin\QueueWorker
View on git.drupalcode.org
View source 
class CronQueueTestException extends QueueWorkerBase {
  
  /**
   * The plugin ID.
   */
  public const PLUGIN_ID = 'cron_queue_test_exception';
  
  /**
   * {@inheritdoc}
   */
  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);
    }
  }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
CronQueueTestException::PLUGIN_ID public constant The plugin ID.
CronQueueTestException::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. 87

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