class FrontendEnvironmentPluginCollection in Build Hooks 3.x

Provides a collection of front plugins.

Hierarchy

• class \Drupal\Component\Plugin\LazyPluginCollection implements \Drupal\Component\Plugin\IteratorAggregate, \Drupal\Component\Plugin\Countable
  • class \Drupal\Core\Plugin\DefaultSingleLazyPluginCollection uses DependencySerializationTrait
    • class \Drupal\build_hooks\FrontendEnvironmentPluginCollection

1 file declares its use of FrontendEnvironmentPluginCollection

FrontendEnvironment.php in src/Entity/FrontendEnvironment.php

File

src/FrontendEnvironmentPluginCollection.php, line 12

Namespace

Drupal\build_hooks

class FrontendEnvironmentPluginCollection extends DefaultSingleLazyPluginCollection {

  /**
   * The frontend environment ID this plugin collection belongs to.
   *
   * @var string
   */
  protected $frontendEnvironmentId;

  /**
   * Constructs a new BlockPluginCollection.
   *
   * @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 string $frontend_environment_id
   *   The unique ID of the frontend environment entity using this plugin.
   */
  public function __construct(PluginManagerInterface $manager, $instance_id, array $configuration, $frontend_environment_id) {
    parent::__construct($manager, $instance_id, $configuration);
    $this->frontendEnvironmentId = $frontend_environment_id;
  }

  /**
   * {@inheritdoc}
   */
  protected function initializePlugin($instance_id) {
    if (!$instance_id) {
      throw new PluginException("The frontend environment '{$this->frontendEnvironmentId}' did not specify a plugin.");
    }
    try {
      parent::initializePlugin($instance_id);
    } catch (PluginException $e) {
      $module = $this->configuration['provider'];

      // Ignore blocks belonging to uninstalled modules, but re-throw valid
      // exceptions when the module is installed and the plugin is
      // misconfigured.
      if (!$module || \Drupal::moduleHandler()
        ->moduleExists($module)) {
        throw $e;
      }
    }
  }

}

Members

Name	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
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FrontendEnvironmentPluginCollection::$frontendEnvironmentId	protected	property	The frontend environment ID this plugin collection belongs to.
FrontendEnvironmentPluginCollection::initializePlugin	protected	function	Initializes and stores a plugin. Overrides DefaultSingleLazyPluginCollection::initializePlugin
FrontendEnvironmentPluginCollection::__construct	public	function	Constructs a new BlockPluginCollection. 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.	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::removeInstanceId	public	function	Removes an instance ID.	1
LazyPluginCollection::set	public	function	Stores an initialized plugin.