VuFind API Documentation

None
in package
implements AutocompleteInterface

No Autocomplete Module

This class allows autocomplete to be disabled for certain search types.

Tags
category

VuFind

author

Demian Katz demian.katz@villanova.edu

license

http://opensource.org/licenses/gpl-2.0.php GNU General Public License

link

Wiki

Interfaces, Classes, Traits and Enums

AutocompleteInterface
Autocomplete Plug-In Interface

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

Return values
void

Search results