public function SearchApiAutocompleteInterface::getAutocompleteSuggestions in Search API Autocomplete 7

Retrieves autocompletion suggestions for some user input.

For example, when given the user input "teach us", with "us" being considered incomplete, the following might be returned:

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

Parameters

SearchApiQueryInterface $query: A query representing the completed user input so far.

SearchApiAutocompleteSearch $search: An object containing details about the search the user is on, and settings for the autocompletion. See the class documentation for details. Especially $search->options should be checked for settings, like whether to try and estimate result counts for returned suggestions.

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

array An array of suggestions, as defined by SearchApiAutocompleteSuggesterInterface::getAutocompleteSuggestions().

File

./search_api_autocomplete.interface.php, line 60

Contains SearchApiAutocompleteInterface.

Class

SearchApiAutocompleteInterface

Interface describing the method a service class has to add to support autocompletion.

Code

public function getAutocompleteSuggestions(SearchApiQueryInterface $query, SearchApiAutocompleteSearch $search, $incomplete_key, $user_input);