AutocompleteInterface
in
Autocomplete Plug-In Interface
This interface class is the definition of the required methods for generating autocomplete suggestions.
Tags
Table of Contents
- getSuggestions() : array<string|int, mixed>
- This method returns an array of strings matching the user's query for display in the autocomplete box.
- setConfig() : void
- Set parameters that affect the behavior of the autocomplete handler.
Methods
getSuggestions()
This method returns an array of strings matching the user's query for display in the autocomplete box.
public
getSuggestions(string $query) : array<string|int, mixed>
Parameters
- $query : string
-
The user query
Return values
array<string|int, mixed> —The suggestions for the provided query
setConfig()
Set parameters that affect the behavior of the autocomplete handler.
public
setConfig(string $params) : void
These values normally come from the search configuration file.
Parameters
- $params : string
-
Parameters to set