class SearchApiAutocompleteSuggester in Search API Autocomplete 8

Defines a autocomplete suggester plugin.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\search_api_autocomplete\Annotation\SearchApiAutocompleteSuggester

See also

\Drupal\search_api_autocomplete\Suggester\SuggesterInterface

\Drupal\search_api_autocomplete\Suggester\SuggesterManager

\Drupal\search_api_autocomplete\Suggester\SuggesterPluginBase

Plugin API

1 file declares its use of SearchApiAutocompleteSuggester

SuggesterManager.php in src/Suggester/SuggesterManager.php

4 classes are annotated with SearchApiAutocompleteSuggester

CustomScript in src/Plugin/search_api_autocomplete/suggester/CustomScript.php

Uses a custom (non-Drupal) script for generating autocomplete suggestions.

LiveResults in src/Plugin/search_api_autocomplete/suggester/LiveResults.php

Provides a suggester plugin that displays live results.

Server in src/Plugin/search_api_autocomplete/suggester/Server.php

Provides a suggester plugin that retrieves suggestions from the server.

TestSuggester in tests/search_api_autocomplete_test/src/Plugin/search_api_autocomplete/suggester/TestSuggester.php

Defines a test suggester class.

File

src/Annotation/SearchApiAutocompleteSuggester.php, line 17

Namespace

Drupal\search_api_autocomplete\Annotation

class SearchApiAutocompleteSuggester extends Plugin {

  /**
   * The plugin label.
   *
   * @var string
   *
   * @ingroup plugin_translatable
   */
  public $label;

  /**
   * The plugin description.
   *
   * @var string
   *
   * @ingroup plugin_translatable
   */
  public $description;

  /**
   * The default weight for this suggester.
   *
   * @var int
   */
  public $default_weight = 0;

}

Members

Name	Modifiers	Type	Description	Overrides
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2
SearchApiAutocompleteSuggester::$default_weight	public	property	The default weight for this suggester.
SearchApiAutocompleteSuggester::$description	public	property	The plugin description.
SearchApiAutocompleteSuggester::$label	public	property	The plugin label.