interface IndexPluginInterface in Search API 8

Represents a plugin that is linked to an index.

Hierarchy

• interface \Drupal\search_api\Plugin\HideablePluginInterface; interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Component\Plugin\DerivativeInspectionInterface; interface \Drupal\Component\Plugin\ConfigurableInterface; interface \Drupal\Component\Plugin\DependentPluginInterface; interface \Drupal\Core\Plugin\ContainerFactoryPluginInterface
  • interface \Drupal\search_api\Plugin\ConfigurablePluginInterface
    • interface \Drupal\search_api\Plugin\IndexPluginInterface

3 files declare their use of IndexPluginInterface

DatasourceInterface.php in src/Datasource/DatasourceInterface.php

ProcessorInterface.php in src/Processor/ProcessorInterface.php

TrackerInterface.php in src/Tracker/TrackerInterface.php

File

src/Plugin/IndexPluginInterface.php, line 10

Namespace

Drupal\search_api\Plugin

interface IndexPluginInterface extends ConfigurablePluginInterface {

  /**
   * Retrieves the index this plugin is configured for.
   *
   * @return \Drupal\search_api\IndexInterface
   *   The index this plugin is configured for.
   */
  public function getIndex();

  /**
   * Sets the index this plugin is configured for.
   *
   * @param \Drupal\search_api\IndexInterface $index
   *   The index this plugin is configured for.
   */
  public function setIndex(IndexInterface $index);

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	11
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	12
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	12
ConfigurablePluginInterface::getDescription	public	function	Returns the plugin's description.	1
ConfigurablePluginInterface::label	public	function	Returns the label for use on the administration pages.	1
ConfigurablePluginInterface::onDependencyRemoval	public	function	Informs the plugin that some of its dependencies are being removed.	1
ContainerFactoryPluginInterface::create	public static	function	Creates an instance of the plugin.	112
DependentPluginInterface::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	19
DerivativeInspectionInterface::getBaseId	public	function	Gets the base_plugin_id of the plugin instance.	1
DerivativeInspectionInterface::getDerivativeId	public	function	Gets the derivative_id of the plugin instance.	1
HideablePluginInterface::isHidden	public	function	Determines whether this plugin should be hidden in the UI.	1
IndexPluginInterface::getIndex	public	function	Retrieves the index this plugin is configured for.	1
IndexPluginInterface::setIndex	public	function	Sets the index this plugin is configured for.	1
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2