class TamperPluginCollection in Tamper 8

A collection of tamper plugins.

Hierarchy

• class \Drupal\Component\Plugin\LazyPluginCollection implements \Drupal\Component\Plugin\IteratorAggregate, \Drupal\Component\Plugin\Countable
  • class \Drupal\Core\Plugin\DefaultLazyPluginCollection uses DependencySerializationTrait
    • class \Drupal\tamper\TamperPluginCollection

1 file declares its use of TamperPluginCollection

TamperConfigSchemaTest.php in tests/src/Kernel/TamperConfigSchemaTest.php

File

src/TamperPluginCollection.php, line 12

Namespace

Drupal\tamper

class TamperPluginCollection extends DefaultLazyPluginCollection {

  /**
   * A definition of which sources there are that Tamper plugins can use.
   *
   * @var \Drupal\tamper\SourceDefinitionInterface
   */
  protected $sourceDefinition;

  /**
   * Constructs a new TamperPluginCollection object.
   *
   * @param \Drupal\Component\Plugin\PluginManagerInterface $manager
   *   The manager to be used for instantiating plugins.
   * @param \Drupal\tamper\SourceDefinitionInterface $source_definition
   *   A definition of which sources there are that Tamper plugins can use.
   * @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, SourceDefinitionInterface $source_definition, array $configurations = []) {
    $this->sourceDefinition = $source_definition;
    parent::__construct($manager, $configurations);
  }

  /**
   * {@inheritdoc}
   */
  protected function initializePlugin($instance_id) {
    $configuration = isset($this->configurations[$instance_id]) ? $this->configurations[$instance_id] : [];
    if (!isset($configuration[$this->pluginKey])) {
      throw new PluginNotFoundException($instance_id);
    }

    // Pass source definition.
    $configuration['source_definition'] = $this->sourceDefinition;
    $this
      ->set($instance_id, $this->manager
      ->createInstance($configuration[$this->pluginKey], $configuration));
  }

}

Members

Name	Modifiers	Type	Description	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::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
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
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::get	public	function	Gets a plugin instance, initializing it if necessary.	4
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::set	public	function	Stores an initialized plugin.
TamperPluginCollection::$sourceDefinition	protected	property	A definition of which sources there are that Tamper plugins can use.
TamperPluginCollection::initializePlugin	protected	function	Initializes and stores a plugin. Overrides DefaultLazyPluginCollection::initializePlugin
TamperPluginCollection::__construct	public	function	Constructs a new TamperPluginCollection object. Overrides DefaultLazyPluginCollection::__construct