DefaultSingleLazyPluginCollection.php

<?php

namespace Drupal\Core\Plugin;

use Drupal\Component\Plugin\ConfigurableInterface;
use Drupal\Component\Plugin\PluginManagerInterface;
use Drupal\Component\Plugin\LazyPluginCollection;
use Drupal\Core\DependencyInjection\DependencySerializationTrait;

/**
 * Provides a default plugin collection for a plugin type.
 *
 * A plugin collection usually stores multiple plugins, and is used to lazily
 * instantiate them. When only one plugin is needed, it is still best practice
 * to encapsulate all of the instantiation logic in a plugin collection. This
 * class can be used directly, or subclassed to add further exception handling
 * in self::initializePlugin().
 */
class DefaultSingleLazyPluginCollection extends LazyPluginCollection {
    use DependencySerializationTrait;
    
    /**
     * The manager used to instantiate the plugins.
     *
     * @var \Drupal\Component\Plugin\PluginManagerInterface
     */
    protected $manager;
    
    /**
     * An array of configuration to instantiate the plugin with.
     *
     * @var array
     */
    protected $configuration;
    
    /**
     * The instance ID used for this plugin collection.
     *
     * @var string
     */
    protected $instanceId;
    
    /**
     * Constructs a new DefaultSingleLazyPluginCollection object.
     *
     * @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.
     */
    public function __construct(PluginManagerInterface $manager, $instance_id, array $configuration) {
        $this->manager = $manager;
        $this->addInstanceId($instance_id, $configuration);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function initializePlugin($instance_id) {
        $this->set($instance_id, $this->manager
            ->createInstance($instance_id, $this->configuration));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getConfiguration() {
        $plugin = $this->get($this->instanceId);
        if ($plugin instanceof ConfigurableInterface) {
            return $plugin->getConfiguration();
        }
        else {
            return $this->configuration;
        }
    }
    
    /**
     * {@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 = [];
        }
        $this->configuration = $configuration;
        $plugin = $this->get($this->instanceId);
        if ($plugin instanceof ConfigurableInterface) {
            $plugin->setConfiguration($configuration);
        }
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function addInstanceId($id, $configuration = NULL) {
        $this->instanceId = $id;
        // Reset the list of instance IDs since there can be only one.
        $this->instanceIds = [];
        parent::addInstanceId($id, $configuration);
        if ($configuration !== NULL) {
            $this->setConfiguration($configuration);
        }
    }

}