abstract class QueueBase in Purge 8.3

Provides a ReliableQueueInterface compliant queue that holds queue items.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\purge\Plugin\Purge\Queue\QueueBase implements QueueInterface uses QueueBasePageTrait

File

src/Plugin/Purge/Queue/QueueBase.php, line 11

Namespace

Drupal\purge\Plugin\Purge\Queue

abstract class QueueBase extends PluginBase implements QueueInterface {
  use QueueBasePageTrait;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition);
  }

  /**
   * {@inheritdoc}
   */
  public function createItemMultiple(array $items) {
    $ids = [];

    // This implementation emulates multiple creation and is NOT efficient. It
    // exists for API reliability and invites derivatives to override it, for
    // example: by one multi-row database query.
    foreach ($items as $data) {
      if (($item = $this
        ->createItem($data)) === FALSE) {
        return FALSE;
      }
      $ids[] = $item;
    }
    return $ids;
  }

  /**
   * {@inheritdoc}
   */
  public function claimItemMultiple($claims = 10, $lease_time = 3600) {
    $items = [];

    // This implementation emulates multiple item claiming and is NOT efficient,
    // but exists to provide a reliable API. Derivatives are invited to override
    // it, for example by one multi-row select database query.
    for ($i = 1; $i <= $claims; $i++) {
      if (($item = $this
        ->claimItem($lease_time)) === FALSE) {
        break;
      }
      $items[] = $item;
    }
    return $items;
  }

  /**
   * {@inheritdoc}
   */
  public function deleteItemMultiple(array $items) {

    // This implementation emulates multiple item deletion and is NOT efficient,
    // but exists to provide API reliability. Derivatives are invited to
    // override it, for example by one multi-row delete database query.
    foreach ($items as $item) {
      $this
        ->deleteItem($item);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function releaseItemMultiple(array $items) {
    $failures = [];

    // This implementation emulates multiple item releases and is NOT efficient,
    // but exists to provide API reliability. Derivatives are invited to
    // override it, for example by a multi-row update database query.
    foreach ($items as $item) {
      if ($this
        ->releaseItem($item) === FALSE) {
        $failures[] = $item;
      }
    }
    return $failures;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
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	3
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.	92
QueueBase::claimItemMultiple	public	function	Claims multiple items from the queue for processing. Overrides QueueInterface::claimItemMultiple	1
QueueBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
QueueBase::createItemMultiple	public	function	Add multiple items to the queue and store them efficiently. Overrides QueueInterface::createItemMultiple	1
QueueBase::deleteItemMultiple	public	function	Delete multiple items from the queue at once. Overrides QueueInterface::deleteItemMultiple	1
QueueBase::releaseItemMultiple	public	function	Release multiple items that the worker could not process. Overrides QueueInterface::releaseItemMultiple	1
QueueBasePageTrait::$selectPageLimit	protected	property	The configured limit of items on selected data pages.
QueueBasePageTrait::selectPageLimit	public	function
QueueBasePageTrait::selectPageMax	public	function
QueueInterface::claimItem	public	function	Claims an item in the queue for processing.	2
QueueInterface::createItem	public	function	Adds a queue item and store it directly to the queue.	2
QueueInterface::createQueue	public	function	Creates a queue.	2
QueueInterface::deleteItem	public	function	Deletes a finished item from the queue.	2
QueueInterface::deleteQueue	public	function	Deletes a queue and every item in the queue.	2
QueueInterface::numberOfItems	public	function	Retrieves the number of items in the queue.	2
QueueInterface::releaseItem	public	function	Releases an item that the worker could not process.	2
QueueInterface::selectPage	public	function	Select a page of queue data with a limited number of items.	2
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.