Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 3
CRAP
0.00% covered (danger)
0.00%
0 / 1
Deprecated
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 3
12
0.00% covered (danger)
0.00%
0 / 1
 setConfig
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 init
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 process
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
1<?php
2
3/**
4 * Deprecated Recommendations Module - used to replace legacy modules that no
5 * longer function due to, for example, external APIs that have been shut down.
6 *
7 * PHP version 8
8 *
9 * Copyright (C) Villanova University 2015.
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  Recommendations
26 * @author   Demian Katz <demian.katz@villanova.edu>
27 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
28 * @link     https://vufind.org/wiki/development:plugins:recommendation_modules Wiki
29 */
30
31namespace VuFind\Recommend;
32
33/**
34 * Deprecated Recommendations Module - used to replace legacy modules that no
35 * longer function due to, for example, external APIs that have been shut down.
36 *
37 * @category VuFind
38 * @package  Recommendations
39 * @author   Demian Katz <demian.katz@villanova.edu>
40 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
41 * @link     https://vufind.org/wiki/development:plugins:recommendation_modules Wiki
42 */
43class Deprecated implements RecommendInterface
44{
45    /**
46     * Store the configuration of the recommendation module.
47     *
48     * @param string $settings Settings from searches.ini.
49     *
50     * @return void
51     */
52    public function setConfig($settings)
53    {
54    }
55
56    /**
57     * Called before the Search Results object performs its main search
58     * (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).
59     * This method is responsible for setting search parameters needed by the
60     * recommendation module and for reading any existing search parameters that may
61     * be needed.
62     *
63     * @param \VuFind\Search\Base\Params $params  Search parameter object
64     * @param \Laminas\Stdlib\Parameters $request Parameter object representing user
65     * request.
66     *
67     * @return void
68     */
69    public function init($params, $request)
70    {
71    }
72
73    /**
74     * Called after the Search Results object has performed its main search. This
75     * may be used to extract necessary information from the Search Results object
76     * or to perform completely unrelated processing.
77     *
78     * @param \VuFind\Search\Base\Results $results Search results object
79     *
80     * @return void
81     */
82    public function process($results)
83    {
84    }
85}