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 SimilarBuilder interface definition.
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2010.
9 * Copyright (C) The National Library of Finland 2016.
10 *
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License version 2,
13 * as published by the Free Software Foundation.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
23 *
24 * @category VuFind
25 * @package  Search
26 * @author   Andrew S. Nagy <vufind-tech@lists.sourceforge.net>
27 * @author   David Maus <maus@hab.de>
28 * @author   Demian Katz <demian.katz@villanova.edu>
29 * @author   Ere Maijala <ere.maijala@helsinki.fi>
30 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
31 * @link     https://vufind.org
32 */
33
34namespace VuFindSearch\Backend\Solr;
35
36use VuFindSearch\ParamBag;
37
38/**
39 * SOLR SimilarBuilder interface definition.
40 *
41 * @category VuFind
42 * @package  Search
43 * @author   Andrew S. Nagy <vufind-tech@lists.sourceforge.net>
44 * @author   David Maus <maus@hab.de>
45 * @author   Demian Katz <demian.katz@villanova.edu>
46 * @author   Ere Maijala <ere.maijala@helsinki.fi>
47 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
48 * @link     https://vufind.org
49 */
50interface SimilarBuilderInterface
51{
52    /**
53     * Build SOLR query based on VuFind query object.
54     *
55     * @param string $id Record id
56     *
57     * @return ParamBag
58     */
59    public function build($id);
60}