public function SuggesterInterface::getAutocompleteSuggestions in Search API Autocomplete 8

Retrieves autocompletion suggestions for some user input.

For example, when given the user input "teach us", with "us" being considered incomplete, \Drupal\search_api_autocomplete\SuggestionInterface objects representing the following suggestions might be returned:

[
  [
    'prefix' => t('Did you mean:'),
    'user_input' => 'reach us',
  ],
  [
    'user_input' => 'teach us',
    'suggestion_suffix' => 'ers',
  ],
  [
    'user_input' => 'teach us',
    'suggestion_suffix' => ' swimming',
  ],
];

Parameters

\Drupal\search_api\Query\QueryInterface $query: A query representing the completed user input so far.

string $incomplete_key: The start of another fulltext keyword for the search, which should be completed. Might be empty, in which case all user input up to now was considered completed. Then, additional keywords for the search could be suggested.

string $user_input: The complete user input for the fulltext search keywords so far.

Return value

\Drupal\search_api_autocomplete\Suggestion\SuggestionInterface[] An array of autocomplete suggestions.

4 methods override SuggesterInterface::getAutocompleteSuggestions()

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

Retrieves autocompletion suggestions for some user input.

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

Retrieves autocompletion suggestions for some user input.

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

Retrieves autocompletion suggestions for some user input.

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

Retrieves autocompletion suggestions for some user input.

File

src/Suggester/SuggesterInterface.php, line 79

Class

SuggesterInterface

Represents a plugin for creating autocomplete suggestions.

Namespace

Drupal\search_api_autocomplete\Suggester

Code

public function getAutocompleteSuggestions(QueryInterface $query, $incomplete_key, $user_input);