Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2
3/**
4 * Autocomplete Plug-In Interface
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2010.
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2,
12 * as published by the Free Software Foundation.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22 *
23 * @category VuFind
24 * @package  Autocomplete
25 * @author   Demian Katz <demian.katz@villanova.edu>
26 * @author   Chris Hallberg <challber@villanova.edu>
27 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
28 * @link     https://vufind.org/wiki/development:plugins:autosuggesters Wiki
29 */
30
31namespace VuFind\Autocomplete;
32
33/**
34 * Autocomplete Plug-In Interface
35 *
36 * This interface class is the definition of the required methods for
37 * generating autocomplete suggestions.
38 *
39 * @category VuFind
40 * @package  Autocomplete
41 * @author   Demian Katz <demian.katz@villanova.edu>
42 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
43 * @link     https://vufind.org/wiki/development:plugins:autosuggesters Wiki
44 */
45interface AutocompleteInterface
46{
47    /**
48     * This method returns an array of strings matching the user's query for
49     * display in the autocomplete box.
50     *
51     * @param string $query The user query
52     *
53     * @return array        The suggestions for the provided query
54     */
55    public function getSuggestions($query);
56
57    /**
58     * Set parameters that affect the behavior of the autocomplete handler.
59     * These values normally come from the search configuration file.
60     *
61     * @param string $params Parameters to set
62     *
63     * @return void
64     */
65    public function setConfig($params);
66}