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 | * Random record retrieval feature 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 Luke O'Sullivan <l.osullivan@swansea.ac.uk> |
26 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
27 | * @link https://vufind.org |
28 | */ |
29 | |
30 | namespace VuFindSearch\Feature; |
31 | |
32 | use VuFindSearch\ParamBag; |
33 | use VuFindSearch\Query\AbstractQuery; |
34 | |
35 | /** |
36 | * Random record retrieval feature interface definition. |
37 | * |
38 | * @category VuFind |
39 | * @package Search |
40 | * @author Luke O'Sullivan <l.osullivan@swansea.ac.uk> |
41 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
42 | * @link https://vufind.org |
43 | */ |
44 | interface RandomInterface |
45 | { |
46 | /** |
47 | * Return random records. |
48 | * |
49 | * @param AbstractQuery $query Search query |
50 | * @param int $limit Search limit |
51 | * @param ParamBag $params Search backend parameters |
52 | * |
53 | * @return \VuFindSearch\Response\RecordCollectionInterface |
54 | */ |
55 | public function random( |
56 | AbstractQuery $query, |
57 | $limit, |
58 | ParamBag $params = null |
59 | ); |
60 | } |