interface PluginInterface in Search API Autocomplete 8

Provides a common interface for autocomplete search plugins.

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_autocomplete\Plugin\PluginInterface

2 files declare their use of PluginInterface

SearchPluginInterface.php in src/Search/SearchPluginInterface.php

SuggesterInterface.php in src/Suggester/SuggesterInterface.php

File

src/Plugin/PluginInterface.php, line 11

Namespace

Drupal\search_api_autocomplete\Plugin

interface PluginInterface extends ConfigurablePluginInterface {

  /**
   * Retrieves the search this plugin is configured for.
   *
   * @return \Drupal\search_api_autocomplete\SearchInterface|null
   *   The search this plugin is configured for, or NULL if no search entity has
   *   yet been set for it.
   */
  public function getSearch();

  /**
   * Sets the search this plugin is configured for.
   *
   * @param \Drupal\search_api_autocomplete\SearchInterface $search
   *   The new search entity this plugin should be linked to.
   *
   * @return $this
   */
  public function setSearch(SearchInterface $search);

}

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
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
PluginInterface::getSearch	public	function	Retrieves the search this plugin is configured for.	1
PluginInterface::setSearch	public	function	Sets the search this plugin is configured for.	1