abstract class SearchPluginBase in Search API Autocomplete 8

Provides a base class for search plugins.

Plugins extending this class need to define a plugin definition array through annotation. The definition includes the following keys:

id: The unique, system-wide identifier of the search plugin.
label: The human-readable name of the search plugin, translated.
description: A human-readable description for the search plugin, translated.

A complete plugin definition should be written as in this example:


@SearchApiAutocompleteSearch(
  id = "my_search",
  label = @Translation("Custom Search"),
  description = @Translation("Custom-defined site-specific search."),
  index = "my_index",
)

View source

abstract class SearchPluginBase extends PluginBase implements SearchPluginInterface {

  /**
   * The entity manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {

    /** @var static $plugin */
    $plugin = parent::create($container, $configuration, $plugin_id, $plugin_definition);
    $plugin
      ->setEntityTypeManager($container
      ->get('entity_type.manager'));
    $plugin
      ->setStringTranslation($container
      ->get('string_translation'));
    return $plugin;
  }

  /**
   * Retrieves the entity manager.
   *
   * @return \Drupal\Core\Entity\EntityTypeManagerInterface
   *   The entity manager.
   */
  public function getEntityTypeManager() {
    return $this->entityTypeManager;
  }

  /**
   * Sets the entity manager.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity manager.
   *
   * @return $this
   */
  public function setEntityTypeManager(EntityTypeManagerInterface $entity_type_manager) {
    $this->entityTypeManager = $entity_type_manager;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getGroupLabel() {
    $plugin_definition = $this
      ->getPluginDefinition();
    if (isset($plugin_definition['group_label'])) {
      return $plugin_definition['group_label'];
    }
    return $this
      ->t('Other searches');
  }

  /**
   * {@inheritdoc}
   */
  public function getGroupDescription() {
    $plugin_definition = $this
      ->getPluginDefinition();
    if (isset($plugin_definition['group_description'])) {
      return $plugin_definition['group_description'];
    }
    return $this
      ->t('Searches not belonging to any specific group');
  }

  /**
   * {@inheritdoc}
   */
  public function getIndexId() {
    return $this
      ->getPluginDefinition()['index'];
  }

  /**
   * {@inheritdoc}
   */
  public function getIndex() {
    return $this
      ->getEntityTypeManager()
      ->getStorage('search_api_index')
      ->load($this
      ->getIndexId());
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurablePluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	6
ConfigurablePluginBase::calculatePluginDependencies Deprecated	protected	function	Calculates and adds dependencies of a specific plugin instance.
ConfigurablePluginBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	11
ConfigurablePluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConfigurablePluginBase::getDescription	public	function	Returns the plugin's description. Overrides ConfigurablePluginInterface::getDescription
ConfigurablePluginBase::getPluginDependencies Deprecated	protected	function	Calculates and returns dependencies of a specific plugin instance.
ConfigurablePluginBase::label	public	function	Returns the label for use on the administration pages. Overrides ConfigurablePluginInterface::label
ConfigurablePluginBase::moduleHandler Deprecated	protected	function	Wraps the module handler.
ConfigurablePluginBase::onDependencyRemoval	public	function	Informs the plugin that some of its dependencies are being removed. Overrides ConfigurablePluginInterface::onDependencyRemoval	5
ConfigurablePluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration	3
ConfigurablePluginBase::themeHandler Deprecated	protected	function	Wraps the theme handler.
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
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency.
HideablePluginBase::isHidden	public	function	Determines whether this plugin should be hidden in the UI. Overrides HideablePluginInterface::isHidden	1
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::$search	protected	property	The search this suggester is attached to.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::getSearch	public	function	Retrieves the search this plugin is configured for. Overrides PluginInterface::getSearch
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::setSearch	public	function	Sets the search this plugin is configured for. Overrides PluginInterface::setSearch
PluginBase::__construct	public	function	Constructs a SearchPluginBase object. Overrides ConfigurablePluginBase::__construct	1
PluginDependencyTrait::calculatePluginDependencies	protected	function	Calculates and adds dependencies of a specific plugin instance. Aliased as: traitCalculatePluginDependencies	1
PluginDependencyTrait::getPluginDependencies	protected	function	Calculates and returns dependencies of a specific plugin instance. Aliased as: traitGetPluginDependencies
PluginDependencyTrait::moduleHandler	protected	function	Wraps the module handler. Aliased as: traitModuleHandler	1
PluginDependencyTrait::themeHandler	protected	function	Wraps the theme handler. Aliased as: traitThemeHandler	1
SearchPluginBase::$entityTypeManager	protected	property	The entity manager.	1
SearchPluginBase::create	public static	function	Creates an instance of the plugin. Overrides ConfigurablePluginBase::create	2
SearchPluginBase::getEntityTypeManager	public	function	Retrieves the entity manager.
SearchPluginBase::getGroupDescription	public	function	Retrieves a description for this search's group. Overrides SearchPluginInterface::getGroupDescription
SearchPluginBase::getGroupLabel	public	function	Retrieves a group label for this search. Overrides SearchPluginInterface::getGroupLabel
SearchPluginBase::getIndex	public	function	Retrieves the index to which this search plugin belongs. Overrides SearchPluginInterface::getIndex
SearchPluginBase::getIndexId	public	function	Retrieves the ID of the index to which this search plugin belongs. Overrides SearchPluginInterface::getIndexId
SearchPluginBase::setEntityTypeManager	public	function	Sets the entity manager.
SearchPluginInterface::createQuery	public	function	Creates a search query based on this search.	3
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

You are here

abstract class SearchPluginBase in Search API Autocomplete 8

Hierarchy

See also

File

Namespace

Members

API Navigation