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 * Common methods that must be shared by all query objects.
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   David Maus <maus@hab.de>
26 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
27 * @link     https://vufind.org
28 */
29
30namespace VuFindSearch\Query;
31
32/**
33 * Common methods that must be shared by all query objects.
34 *
35 * @category VuFind
36 * @package  Search
37 * @author   David Maus <maus@hab.de>
38 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
39 * @link     https://vufind.org
40 */
41interface QueryInterface
42{
43    /**
44     * Does the query contain the specified term? An optional normalizer can be
45     * provided to allow for fuzzier matching.
46     *
47     * @param string   $needle     Term to check
48     * @param callable $normalizer Function to normalize text strings (null for
49     * no normalization)
50     *
51     * @return bool
52     */
53    public function containsTerm($needle, $normalizer = null);
54
55    /**
56     * Get a concatenated list of all query strings within the object.
57     *
58     * @return string
59     */
60    public function getAllTerms();
61
62    /**
63     * Replace a term.
64     *
65     * @param string   $from       Search term to find
66     * @param string   $to         Search term to insert
67     * @param callable $normalizer Function to normalize text strings (null for
68     * no normalization)
69     *
70     * @return void
71     */
72    public function replaceTerm($from, $to, $normalizer = null);
73}