You are here

class EntityQueueHandlerPluginCollection in Entityqueue 8

Provides a container for lazily loading EntityQueueHandler plugins.

Hierarchy

Expanded class hierarchy of EntityQueueHandlerPluginCollection

1 file declares its use of EntityQueueHandlerPluginCollection
EntityQueue.php in src/Entity/EntityQueue.php

File

src/EntityQueueHandlerPluginCollection.php, line 11

Namespace

Drupal\entityqueue
View source
class EntityQueueHandlerPluginCollection extends DefaultSingleLazyPluginCollection {

  /**
   * The entity queue that is using this plugin collection.
   *
   * @var \Drupal\entityqueue\Entity\EntityQueue
   */
  protected $queue;

  /**
   * Constructs a new EntityQueueHandlerPluginCollection.
   *
   * @param \Drupal\Component\Plugin\PluginManagerInterface $manager
   *   The manager to be used for instantiating plugins.
   * @param string $instance_id
   *   The ID of the plugin instance.
   * @param array $configuration
   *   An array of configuration.
   * @param \Drupal\entityqueue\EntityQueueInterface $queue
   *   The entity queue using this plugin.
   */
  public function __construct(PluginManagerInterface $manager, $instance_id, array $configuration, EntityQueueInterface $queue) {
    $this->queue = $queue;
    parent::__construct($manager, $instance_id, $configuration);
  }

  /**
   * {@inheritdoc}
   *
   * @return \Drupal\entityqueue\EntityQueueHandlerInterface
   */
  public function &get($instance_id) {
    return parent::get($instance_id);
  }

  /**
   * {@inheritdoc}
   */
  protected function initializePlugin($instance_id) {
    parent::initializePlugin($instance_id);
    $this->pluginInstances[$instance_id]
      ->setQueue($this->queue);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DefaultSingleLazyPluginCollection::$configuration protected property An array of configuration to instantiate the plugin with.
DefaultSingleLazyPluginCollection::$instanceId protected property The instance ID used for this plugin collection.
DefaultSingleLazyPluginCollection::$manager protected property The manager used to instantiate the plugins.
DefaultSingleLazyPluginCollection::addInstanceId public function Adds an instance ID to the available instance IDs. Overrides LazyPluginCollection::addInstanceId
DefaultSingleLazyPluginCollection::getConfiguration public function Gets the current configuration of all plugins in this collection. Overrides LazyPluginCollection::getConfiguration
DefaultSingleLazyPluginCollection::setConfiguration public function Sets the configuration for all plugins in this collection. Overrides LazyPluginCollection::setConfiguration
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
EntityQueueHandlerPluginCollection::$queue protected property The entity queue that is using this plugin collection.
EntityQueueHandlerPluginCollection::get public function Overrides LazyPluginCollection::get
EntityQueueHandlerPluginCollection::initializePlugin protected function Initializes and stores a plugin. Overrides DefaultSingleLazyPluginCollection::initializePlugin
EntityQueueHandlerPluginCollection::__construct public function Constructs a new EntityQueueHandlerPluginCollection. Overrides DefaultSingleLazyPluginCollection::__construct
LazyPluginCollection::$instanceIds protected property Stores the IDs of all potential plugin instances.
LazyPluginCollection::$pluginInstances protected property Stores all instantiated plugins.
LazyPluginCollection::clear public function Clears all instantiated plugins.
LazyPluginCollection::count public function
LazyPluginCollection::getInstanceIds public function Gets all instance IDs.
LazyPluginCollection::getIterator public function
LazyPluginCollection::has public function Determines if a plugin instance exists.
LazyPluginCollection::remove public function Removes an initialized plugin.
LazyPluginCollection::removeInstanceId public function Removes an instance ID.
LazyPluginCollection::set public function Stores an initialized plugin.