class SearchPluginCollection

Same name in other branches
  1. 9 core/modules/search/src/Plugin/SearchPluginCollection.php \Drupal\search\Plugin\SearchPluginCollection
  2. 10 core/modules/search/src/Plugin/SearchPluginCollection.php \Drupal\search\Plugin\SearchPluginCollection
  3. 11.x core/modules/search/src/Plugin/SearchPluginCollection.php \Drupal\search\Plugin\SearchPluginCollection

Provides a container for lazily loading search plugins.

Hierarchy

Expanded class hierarchy of SearchPluginCollection

2 files declare their use of SearchPluginCollection
SearchPage.php in core/modules/search/src/Entity/SearchPage.php
SearchPluginCollectionTest.php in core/modules/search/tests/src/Unit/SearchPluginCollectionTest.php

File

core/modules/search/src/Plugin/SearchPluginCollection.php, line 11

Namespace

Drupal\search\Plugin
View source
class SearchPluginCollection extends DefaultSingleLazyPluginCollection {
    
    /**
     * The unique ID for the search page using this plugin collection.
     *
     * @var string
     */
    protected $searchPageId;
    
    /**
     * 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 $search_page_id
     *   The unique ID of the search page using this plugin.
     */
    public function __construct(PluginManagerInterface $manager, $instance_id, array $configuration, $search_page_id) {
        parent::__construct($manager, $instance_id, $configuration);
        $this->searchPageId = $search_page_id;
    }
    
    /**
     * {@inheritdoc}
     *
     * @return \Drupal\search\Plugin\SearchInterface
     */
    public function &get($instance_id) {
        return parent::get($instance_id);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function initializePlugin($instance_id) {
        parent::initializePlugin($instance_id);
        $plugin_instance = $this->pluginInstances[$instance_id];
        if ($plugin_instance instanceof ConfigurableSearchPluginInterface) {
            $plugin_instance->setSearchPageId($this->searchPageId);
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title 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. 1
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. 1
LazyPluginCollection::removeInstanceId public function Removes an instance ID. 1
LazyPluginCollection::set public function Stores an initialized plugin.
SearchPluginCollection::$searchPageId protected property The unique ID for the search page using this plugin collection.
SearchPluginCollection::get public function Overrides LazyPluginCollection::get
SearchPluginCollection::initializePlugin protected function Initializes and stores a plugin. Overrides DefaultSingleLazyPluginCollection::initializePlugin
SearchPluginCollection::__construct public function Constructs a new SearchPluginCollection. Overrides DefaultSingleLazyPluginCollection::__construct

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