You are here

Home » API reference » Analytics 8 » ServicePluginCollection.php

class ServicePluginCollection in Analytics 8

Hierarchy

Expanded class hierarchy of ServicePluginCollection

1 file declares its use of ServicePluginCollection
AnalyticsService.php in src/Entity/AnalyticsService.php

File

src/Plugin/ServicePluginCollection.php, line 8

Namespace

Drupal\analytics\Plugin
View source 
class ServicePluginCollection extends DefaultSingleLazyPluginCollection {

  /**
   * The unique ID for the search page using this plugin collection.
   *
   * @var string
   */
  protected $analyticsServiceId;

  /**
   * Constructs a new SearchPluginCollection.
   *
   * @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 $analytics_service_id
   *   The unique ID of the analytics service using this plugin.
   */
  public function __construct(PluginManagerInterface $manager, $instance_id, array $configuration, $analytics_service_id) {
    $this->analyticsServiceId = $analytics_service_id;
    parent::__construct($manager, $instance_id, $configuration);
  }

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

  /**
   * {@inheritdoc}
   */
  protected function initializePlugin($instance_id) {
    parent::initializePlugin($instance_id);

    /** @var \Drupal\analytics\Plugin\ServicePluginBase $plugin_instance */
    $plugin_instance = $this->pluginInstances[$instance_id];
    $plugin_instance
      ->setServiceId($this->analyticsServiceId);
  }

}

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
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.
ServicePluginCollection::$analyticsServiceId protected property The unique ID for the search page using this plugin collection.
ServicePluginCollection::get public function Overrides LazyPluginCollection::get
ServicePluginCollection::initializePlugin protected function Initializes and stores a plugin. Overrides DefaultSingleLazyPluginCollection::initializePlugin
ServicePluginCollection::__construct public function Constructs a new SearchPluginCollection. Overrides DefaultSingleLazyPluginCollection::__construct