abstract class MessageQueueBase in Open Social 10.2.x

Provides base functionality for the ReportWorkers.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Queue\QueueWorkerBase implements QueueWorkerInterface
    • class \Drupal\activity_logger\Plugin\QueueWorker\MessageQueueBase

File

modules/custom/activity_logger/src/Plugin/QueueWorker/MessageQueueBase.php, line 11

Namespace

Drupal\activity_logger\Plugin\QueueWorker

abstract class MessageQueueBase extends QueueWorkerBase {

  /**
   * The queue.
   *
   * @var \Drupal\Core\Queue\QueueFactory
   */
  protected $queue;

  /**
   * MessageQueueBase constructor.
   *
   * @param array $configuration
   *   The configuration.
   * @param string $plugin_id
   *   The plugin id.
   * @param array $plugin_definition
   *   The plugin definition.
   * @param \Drupal\Core\Queue\QueueFactory $queue
   *   The queue.
   */
  public function __construct(array $configuration, $plugin_id, array $plugin_definition, QueueFactory $queue) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->queue = $queue;
  }

  /**
   * Simple reporter log and display information about the queue.
   *
   * @param string $queue_name
   *   The queue name.
   * @param object $data
   *   The $data which should be stored in the queue item.
   */
  protected function createQueueItem($queue_name, $data) {
    $queue = $this->queue
      ->get($queue_name);
    $queue
      ->createItem($data);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MessageQueueBase::$queue	protected	property	The queue.
MessageQueueBase::createQueueItem	protected	function	Simple reporter log and display information about the queue.
MessageQueueBase::__construct	public	function	MessageQueueBase constructor. Overrides PluginBase::__construct	1
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.
QueueWorkerInterface::processItem	public	function	Works on a single queue item.	8