You are here

Home » API reference » Entityqueue 8 » Multiple.php

class Multiple in Entityqueue 8

Defines an entity queue handler that manages multiple subqueues.

Plugin annotation


@EntityQueueHandler(
  id = "multiple",
  title = @Translation("Multiple subqueues"),
  description = @Translation("Provides the ability to add many subqueues to a single queue."),
)

Hierarchy

Expanded class hierarchy of Multiple

1 file declares its use of Multiple
SmartQueue.php in modules/entityqueue_smartqueue/src/Plugin/EntityQueueHandler/SmartQueue.php

File

src/Plugin/EntityQueueHandler/Multiple.php, line 21

Namespace

Drupal\entityqueue\Plugin\EntityQueueHandler
View source 
class Multiple extends EntityQueueHandlerBase implements ContainerFactoryPluginInterface {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs a Multiple queue handler object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin ID for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function supportsMultipleSubqueues() {
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function hasAutomatedSubqueues() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function onQueuePostDelete(EntityQueueInterface $queue, EntityStorageInterface $storage) {

    // Delete all the subqueues when the parent queue is deleted.
    $subqueue_storage = $this->entityTypeManager
      ->getStorage('entity_subqueue');
    $subqueues = $subqueue_storage
      ->loadByProperties([
      $this->entityTypeManager
        ->getDefinition('entity_subqueue')
        ->getKey('bundle') => $queue
        ->id(),
    ]);
    $subqueue_storage
      ->delete($subqueues);
  }

}

Members

Namesort descending 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
EntityQueueHandlerBase::$queue protected property The entity queue that is using this plugin.
EntityQueueHandlerBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 2
EntityQueueHandlerBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
EntityQueueHandlerBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 2
EntityQueueHandlerBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
EntityQueueHandlerBase::getQueueListBuilderOperations public function Gets this queue handler's list builder operations. Overrides EntityQueueHandlerInterface::getQueueListBuilderOperations 1
EntityQueueHandlerBase::onQueuePostLoad public function Acts on loaded entity queues. Overrides EntityQueueHandlerInterface::onQueuePostLoad
EntityQueueHandlerBase::onQueuePostSave public function Acts on an entity queue before the insert or update hook is invoked. Overrides EntityQueueHandlerInterface::onQueuePostSave 2
EntityQueueHandlerBase::onQueuePreDelete public function Acts on entity queues before they are deleted and before hooks are invoked. Overrides EntityQueueHandlerInterface::onQueuePreDelete
EntityQueueHandlerBase::onQueuePreSave public function Acts on an entity queue before the presave hook is invoked. Overrides EntityQueueHandlerInterface::onQueuePreSave
EntityQueueHandlerBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
EntityQueueHandlerBase::setQueue public function Sets the entity queue that is using this plugin. Overrides EntityQueueHandlerInterface::setQueue
EntityQueueHandlerBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm 2
EntityQueueHandlerBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 1
Multiple::$entityTypeManager protected property The entity type manager.
Multiple::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 1
Multiple::hasAutomatedSubqueues public function Whether or not the handler contains subqueues with an automated lifecycle. Overrides EntityQueueHandlerInterface::hasAutomatedSubqueues 1
Multiple::onQueuePostDelete public function Acts on deleted entity queues before the delete hook is invoked. Overrides EntityQueueHandlerBase::onQueuePostDelete 1
Multiple::supportsMultipleSubqueues public function Whether or not the handler supports multiple subqueues. Overrides EntityQueueHandlerInterface::supportsMultipleSubqueues
Multiple::__construct public function Constructs a Multiple queue handler object. Overrides EntityQueueHandlerBase::__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 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.
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.