class DefaultLazyPluginCollection

Same name in other branches
  1. 9 core/lib/Drupal/Core/Plugin/DefaultLazyPluginCollection.php \Drupal\Core\Plugin\DefaultLazyPluginCollection
  2. 8.9.x core/lib/Drupal/Core/Plugin/DefaultLazyPluginCollection.php \Drupal\Core\Plugin\DefaultLazyPluginCollection
  3. 11.x core/lib/Drupal/Core/Plugin/DefaultLazyPluginCollection.php \Drupal\Core\Plugin\DefaultLazyPluginCollection

Provides a default plugin collection for a plugin type.

A plugin collection is used to contain plugins that will be lazily instantiated. The configurations of each potential plugin are passed in, and the configuration key containing the plugin ID is specified by self::$pluginKey.

Hierarchy

Expanded class hierarchy of DefaultLazyPluginCollection

9 files declare their use of DefaultLazyPluginCollection
ConditionPluginCollection.php in core/lib/Drupal/Core/Condition/ConditionPluginCollection.php
ConfigEntityBaseUnitTest.php in core/tests/Drupal/Tests/Core/Config/Entity/ConfigEntityBaseUnitTest.php
DefaultLazyPluginCollectionTest.php in core/tests/Drupal/Tests/Core/Plugin/DefaultLazyPluginCollectionTest.php
DisplayPluginCollection.php in core/modules/views/src/DisplayPluginCollection.php
EntityDisplayPluginCollection.php in core/lib/Drupal/Core/Entity/EntityDisplayPluginCollection.php

... See full list

File

core/lib/Drupal/Core/Plugin/DefaultLazyPluginCollection.php, line 19

Namespace

Drupal\Core\Plugin
View source
class DefaultLazyPluginCollection extends LazyPluginCollection {
    use DependencySerializationTrait;
    
    /**
     * The manager used to instantiate the plugins.
     *
     * @var \Drupal\Component\Plugin\PluginManagerInterface
     */
    protected $manager;
    
    /**
     * The initial configuration for each plugin in the collection.
     *
     * @var array
     *   An associative array containing the initial configuration for each plugin
     *   in the collection, keyed by plugin instance ID.
     */
    protected $configurations = [];
    
    /**
     * The key within the plugin configuration that contains the plugin ID.
     *
     * @var string
     */
    protected $pluginKey = 'id';
    
    /**
     * The original order of the instances.
     *
     * @var array
     */
    protected $originalOrder = [];
    
    /**
     * Constructs a new DefaultLazyPluginCollection object.
     *
     * @param \Drupal\Component\Plugin\PluginManagerInterface $manager
     *   The manager to be used for instantiating plugins.
     * @param array $configurations
     *   (optional) An associative array containing the initial configuration for
     *   each plugin in the collection, keyed by plugin instance ID.
     */
    public function __construct(PluginManagerInterface $manager, array $configurations = []) {
        $this->manager = $manager;
        $this->configurations = $configurations;
        if (!empty($configurations)) {
            $instance_ids = array_keys($configurations);
            $this->instanceIds = array_combine($instance_ids, $instance_ids);
            // Store the original order of the instance IDs for export.
            $this->originalOrder = $this->instanceIds;
        }
    }
    
    /**
     * {@inheritdoc}
     */
    protected function initializePlugin($instance_id) {
        $configuration = $this->configurations[$instance_id] ?? [];
        if (!isset($configuration[$this->pluginKey])) {
            throw new PluginNotFoundException($instance_id);
        }
        $this->set($instance_id, $this->manager
            ->createInstance($configuration[$this->pluginKey], $configuration));
    }
    
    /**
     * Sorts all plugin instances in this collection.
     *
     * @return $this
     */
    public function sort() {
        uasort($this->instanceIds, [
            $this,
            'sortHelper',
        ]);
        return $this;
    }
    
    /**
     * Provides uasort() callback to sort plugins.
     */
    public function sortHelper($aID, $bID) {
        $a = $this->get($aID);
        $b = $this->get($bID);
        return strnatcasecmp($a->getPluginId(), $b->getPluginId());
    }
    
    /**
     * {@inheritdoc}
     */
    public function getConfiguration() {
        $instances = [];
        // Store the current order of the instances.
        $current_order = $this->instanceIds;
        // Reorder the instances to match the original order, adding new instances
        // to the end.
        $this->instanceIds = $this->originalOrder + $current_order;
        foreach ($this as $instance_id => $instance) {
            if ($instance instanceof ConfigurableInterface) {
                $instances[$instance_id] = $instance->getConfiguration();
            }
            else {
                $instances[$instance_id] = $this->configurations[$instance_id];
            }
        }
        // Restore the current order.
        $this->instanceIds = $current_order;
        return $instances;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setConfiguration($configuration) {
        if (!is_array($configuration)) {
            @trigger_error('Calling ' . __METHOD__ . '() with a non-array argument is deprecated in drupal:10.3.0 and will fail in drupal:11.0.0. See https://www.drupal.org/node/3406191', E_USER_DEPRECATED);
            $configuration = [];
        }
        // Track each instance ID as it is updated.
        $unprocessed_instance_ids = $this->getInstanceIds();
        foreach ($configuration as $instance_id => $instance_configuration) {
            $this->setInstanceConfiguration($instance_id, $instance_configuration);
            // Remove this instance ID from the list being updated.
            unset($unprocessed_instance_ids[$instance_id]);
        }
        // Remove remaining instances that had no configuration specified for them.
        foreach ($unprocessed_instance_ids as $unprocessed_instance_id) {
            $this->removeInstanceId($unprocessed_instance_id);
        }
        return $this;
    }
    
    /**
     * Updates the configuration for a plugin instance.
     *
     * If there is no plugin instance yet, a new will be instantiated. Otherwise,
     * the existing instance is updated with the new configuration.
     *
     * @param string $instance_id
     *   The ID of a plugin to set the configuration for.
     * @param array $configuration
     *   The plugin configuration to set.
     */
    public function setInstanceConfiguration($instance_id, array $configuration) {
        if (isset($this->pluginInstances[$instance_id]) && isset($configuration[$this->pluginKey]) && isset($this->configurations[$instance_id][$this->pluginKey]) && $configuration[$this->pluginKey] !== $this->configurations[$instance_id][$this->pluginKey]) {
            // If the plugin has already been instantiated by the configuration was
            // for a different plugin then we need to unset the instantiated plugin.
            unset($this->pluginInstances[$instance_id]);
        }
        $this->configurations[$instance_id] = $configuration;
        $instance = $this->get($instance_id);
        if ($instance instanceof ConfigurableInterface) {
            $instance->setConfiguration($configuration);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function addInstanceId($id, $configuration = NULL) {
        parent::addInstanceId($id);
        if ($configuration !== NULL) {
            $this->setInstanceConfiguration($id, $configuration);
        }
        if (!isset($this->originalOrder[$id])) {
            $this->originalOrder[$id] = $id;
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function removeInstanceId($instance_id) {
        parent::removeInstanceId($instance_id);
        unset($this->originalOrder[$instance_id]);
        unset($this->configurations[$instance_id]);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DefaultLazyPluginCollection::$configurations protected property The initial configuration for each plugin in the collection.
DefaultLazyPluginCollection::$manager protected property The manager used to instantiate the plugins.
DefaultLazyPluginCollection::$originalOrder protected property The original order of the instances.
DefaultLazyPluginCollection::$pluginKey protected property The key within the plugin configuration that contains the plugin ID. 3
DefaultLazyPluginCollection::addInstanceId public function Adds an instance ID to the available instance IDs. Overrides LazyPluginCollection::addInstanceId
DefaultLazyPluginCollection::getConfiguration public function Gets the current configuration of all plugins in this collection. Overrides LazyPluginCollection::getConfiguration 2
DefaultLazyPluginCollection::initializePlugin protected function Initializes and stores a plugin. Overrides LazyPluginCollection::initializePlugin 2
DefaultLazyPluginCollection::removeInstanceId public function Removes an instance ID. Overrides LazyPluginCollection::removeInstanceId
DefaultLazyPluginCollection::setConfiguration public function Sets the configuration for all plugins in this collection. Overrides LazyPluginCollection::setConfiguration
DefaultLazyPluginCollection::setInstanceConfiguration public function Updates the configuration for a plugin instance.
DefaultLazyPluginCollection::sort public function Sorts all plugin instances in this collection. 1
DefaultLazyPluginCollection::sortHelper public function Provides uasort() callback to sort plugins. 2
DefaultLazyPluginCollection::__construct public function Constructs a new DefaultLazyPluginCollection object. 1
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
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. 1
LazyPluginCollection::count public function
LazyPluginCollection::get public function Gets a plugin instance, initializing it if necessary. 8
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. 1
LazyPluginCollection::set public function Stores an initialized plugin.

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