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 | * SOLR QueryBuilder interface definition. |
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 Search |
25 | * @author Andrew S. Nagy <vufind-tech@lists.sourceforge.net> |
26 | * @author David Maus <maus@hab.de> |
27 | * @author Demian Katz <demian.katz@villanova.edu> |
28 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
29 | * @link https://vufind.org |
30 | */ |
31 | |
32 | namespace VuFindSearch\Backend\Solr; |
33 | |
34 | use VuFindSearch\ParamBag; |
35 | use VuFindSearch\Query\AbstractQuery; |
36 | |
37 | /** |
38 | * SOLR QueryBuilder interface definition. |
39 | * |
40 | * @category VuFind |
41 | * @package Search |
42 | * @author Andrew S. Nagy <vufind-tech@lists.sourceforge.net> |
43 | * @author David Maus <maus@hab.de> |
44 | * @author Demian Katz <demian.katz@villanova.edu> |
45 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
46 | * @link https://vufind.org |
47 | */ |
48 | interface QueryBuilderInterface |
49 | { |
50 | /** |
51 | * Build query based on VuFind query object. |
52 | * |
53 | * @param AbstractQuery $query User query |
54 | * @param ?ParamBag $params Search backend parameters |
55 | * |
56 | * @return ParamBag |
57 | */ |
58 | public function build(AbstractQuery $query, ?ParamBag $params = null); |
59 | |
60 | /** |
61 | * Control whether or not the QueryBuilder should create a spellcheck.q |
62 | * parameter. (Turned off by default). |
63 | * |
64 | * @param bool $enable Should spelling query generation be enabled? |
65 | * |
66 | * @return void |
67 | */ |
68 | public function setCreateSpellingQuery($enable); |
69 | } |