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 * Related Records 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  Related_Records
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:related_records_modules Wiki
28 */
29
30namespace VuFind\Related;
31
32/**
33 * Related Records Interface
34 *
35 * This interface class is the definition of the required methods for
36 * generating record recommendations.
37 *
38 * Note that every class implementing this interface needs to be accompanied by
39 * a template file in the Related subdirectory of every theme's template
40 * directory. For example, \VuFind\Related\Similar needs a corresponding
41 * Related/Similar.phtml template. The template will be rendered as a
42 * partial with two available variables: related (the related records object)
43 * and driver (the record driver representing the source record).
44 *
45 * @category VuFind
46 * @package  Related_Records
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:related_records_modules Wiki
50 */
51interface RelatedInterface
52{
53    /**
54     * Establishes base settings for making recommendations.
55     *
56     * @param string                            $settings Settings from config.ini
57     * @param \VuFind\RecordDriver\AbstractBase $driver   Record driver object
58     *
59     * @return void
60     */
61    public function init($settings, $driver);
62}