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 * Optional backend feature: Get identifiers of records.
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 * @author   Ere Maijala <ere.maijala@helsinki.fi>
27 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
28 * @link     https://vufind.org
29 */
30
31namespace VuFindSearch\Feature;
32
33use VuFindSearch\ParamBag;
34use VuFindSearch\Query\AbstractQuery;
35
36/**
37 * Optional backend feature: Get identifiers of records.
38 *
39 * @category VuFind
40 * @package  Search
41 * @author   Ere Maijala <ere.maijala@helsinki.fi>
42 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
43 * @link     https://vufind.org
44 */
45interface GetIdsInterface
46{
47    /**
48     * Perform a search and return record collection of only record identifiers.
49     *
50     * @param AbstractQuery $query  Search query
51     * @param int           $offset Search offset
52     * @param int           $limit  Search limit
53     * @param ParamBag      $params Search backend parameters
54     *
55     * @return \VuFindSearch\Response\RecordCollectionInterface
56     */
57    public function getIds(
58        AbstractQuery $query,
59        $offset,
60        $limit,
61        ParamBag $params = null
62    );
63}