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 | * Search Recommendations Interface |
5 | * |
6 | * PHP version 8 |
7 | * |
8 | * Copyright (C) Villanova University 2009. |
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 Recommendations |
25 | * @author Demian Katz <demian.katz@villanova.edu> |
26 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
27 | * @link https://vufind.org/wiki/development:plugins:recommendation_modules Wiki |
28 | */ |
29 | |
30 | namespace VuFind\Recommend; |
31 | |
32 | /** |
33 | * Search Recommendations Interface |
34 | * |
35 | * This interface class is the definition of the required methods for |
36 | * generating search recommendations. |
37 | * |
38 | * Note that every class implementing this interface needs to be accompanied by |
39 | * a template file in the Recommend subdirectory of every theme's template |
40 | * directory. For example, \VuFind\Recommend\SideFacets needs a corresponding |
41 | * Recommend/SideFacets.phtml template. The template will be rendered as a |
42 | * partial with two available variables: recommend (the recommendation object) |
43 | * and results (the search results object). |
44 | * |
45 | * @category VuFind |
46 | * @package Recommendations |
47 | * @author Demian Katz <demian.katz@villanova.edu> |
48 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
49 | * @link https://vufind.org/wiki/development:plugins:recommendation_modules Wiki |
50 | */ |
51 | interface RecommendInterface |
52 | { |
53 | /** |
54 | * Store the configuration of the recommendation module. |
55 | * |
56 | * @param string $settings Settings from searches.ini. |
57 | * |
58 | * @return void |
59 | */ |
60 | public function setConfig($settings); |
61 | |
62 | /** |
63 | * Called before the Search Results object performs its main search |
64 | * (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED). |
65 | * This method is responsible for setting search parameters needed by the |
66 | * recommendation module and for reading any existing search parameters that may |
67 | * be needed. |
68 | * |
69 | * @param \VuFind\Search\Base\Params $params Search parameter object |
70 | * @param \Laminas\Stdlib\Parameters $request Parameter object representing user |
71 | * request. |
72 | * |
73 | * @return void |
74 | */ |
75 | public function init($params, $request); |
76 | |
77 | /** |
78 | * Called after the Search Results object has performed its main search. This |
79 | * may be used to extract necessary information from the Search Results object |
80 | * or to perform completely unrelated processing. |
81 | * |
82 | * @param \VuFind\Search\Base\Results $results Search results object |
83 | * |
84 | * @return void |
85 | */ |
86 | public function process($results); |
87 | } |