PluginInterface.php in Search API Autocomplete 8

Namespace

Drupal\search_api_autocomplete\Plugin

File

src/Plugin/PluginInterface.php

<?php

namespace Drupal\search_api_autocomplete\Plugin;

use Drupal\search_api\Plugin\ConfigurablePluginInterface;
use Drupal\search_api_autocomplete\SearchInterface;

/**
 * Provides a common interface for autocomplete search plugins.
 */
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);

}

Interfaces

Name	Description
PluginInterface	Provides a common interface for autocomplete search plugins.