Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
87.50% covered (warning)
87.50%
7 / 8
66.67% covered (warning)
66.67%
2 / 3
CRAP
0.00% covered (danger)
0.00%
0 / 1
Tag
87.50% covered (warning)
87.50%
7 / 8
66.67% covered (warning)
66.67%
2 / 3
5.05
0.00% covered (danger)
0.00%
0 / 1
 __construct
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getSuggestions
100.00% covered (success)
100.00%
6 / 6
100.00% covered (success)
100.00%
1 / 1
3
 setConfig
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
1<?php
2
3/**
4 * Tag Autocomplete Module
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2010-2023.
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 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
27 * @link     https://vufind.org/wiki/development:plugins:autosuggesters Wiki
28 */
29
30namespace VuFind\Autocomplete;
31
32use VuFind\Tags\TagsService;
33
34/**
35 * Tag Autocomplete Module
36 *
37 * This class provides suggestions by using the local tag database.
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 */
45class Tag implements AutocompleteInterface
46{
47    /**
48     * Constructor
49     *
50     * @param TagsService $tagsService Tag database service
51     */
52    public function __construct(protected TagsService $tagsService)
53    {
54    }
55
56    /**
57     * This method returns an array of strings matching the user's query for
58     * display in the autocomplete box.
59     *
60     * @param string $query The user query
61     *
62     * @return array        The suggestions for the provided query
63     */
64    public function getSuggestions($query)
65    {
66        $tagList = [];
67        $tags = $this->tagsService->getNonListTagsFuzzilyMatchingString($query);
68        if ($tags) {
69            foreach ($tags as $tag) {
70                $tagList[] = $tag['tag'];
71            }
72        }
73        return $tagList;
74    }
75
76    /**
77     * Set parameters that affect the behavior of the autocomplete handler.
78     * These values normally come from the search configuration file.
79     *
80     * @param string $params Parameters to set
81     *
82     * @return void
83     */
84    public function setConfig($params)
85    {
86        // Ignore all parameters
87    }
88}