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 some extra details about a search,
5 * e.g. the search parameters or request url
6 *
7 * PHP version 8
8 *
9 * Copyright (C) Hebis Verbundzentrale 2023.
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   Thomas Wagener <wagener@hebis.uni-frankfurt.de>
27 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
28 * @link     https://vufind.org/wiki/development Wiki
29 */
30
31namespace VuFindSearch\Feature;
32
33/**
34 * Optional backend feature: Get more information about requests.
35 *
36 * @category VuFind
37 * @package  Search
38 * @author   Thomas Wagener <wagener@hebis.uni-frankfurt.de>
39 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
40 * @link     https://vufind.org/wiki/development Wiki
41 */
42interface ExtraRequestDetailsInterface
43{
44    /**
45     * Returns some extra details about the requests.
46     *
47     * @return array
48     */
49    public function getExtraRequestDetails();
50
51    /**
52     * Clears all accumulated extra request details
53     *
54     * @return void
55     */
56    public function resetExtraRequestDetails();
57}