class SearchApiAutocompleteSearch in Search API Autocomplete 8

Defines an autocompletion search.

Hierarchy

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

See also

\Drupal\search_api_autocomplete\Search\SearchPluginInterface

\Drupal\search_api_autocomplete\Search\SearchPluginManager

\Drupal\search_api_autocomplete\Search\SearchPluginBase

Plugin API

1 file declares its use of SearchApiAutocompleteSearch

SearchPluginManager.php in src/Search/SearchPluginManager.php

3 classes are annotated with SearchApiAutocompleteSearch

Page in src/Plugin/search_api_autocomplete/search/Page.php

Provides autocomplete support for the search_api_page module.

TestSearch in tests/search_api_autocomplete_test/src/Plugin/search_api_autocomplete/search/TestSearch.php

Defines a test search plugin class.

Views in src/Plugin/search_api_autocomplete/search/Views.php

Provides autocomplete support for Views search.

File

src/Annotation/SearchApiAutocompleteSearch.php, line 17

Namespace

Drupal\search_api_autocomplete\Annotation

class SearchApiAutocompleteSearch extends Plugin {

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

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

  /**
   * The search's group label.
   *
   * @var string
   *
   * @ingroup plugin_translatable
   */
  public $group_label = NULL;

  /**
   * The search's group's description.
   *
   * @var string
   *
   * @ingroup plugin_translatable
   */
  public $group_description = NULL;

  /**
   * The search's index ID.
   *
   * @var string
   */
  public $index;

}

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
SearchApiAutocompleteSearch::$description	public	property	The search description.
SearchApiAutocompleteSearch::$group_description	public	property	The search's group's description.
SearchApiAutocompleteSearch::$group_label	public	property	The search's group label.
SearchApiAutocompleteSearch::$index	public	property	The search's index ID.
SearchApiAutocompleteSearch::$label	public	property	The search label.