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 * Channel provider interface.
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2016.
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  Channels
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 Wiki
28 */
29
30namespace VuFind\ChannelProvider;
31
32use VuFind\RecordDriver\AbstractBase as RecordDriver;
33use VuFind\Search\Base\Params;
34use VuFind\Search\Base\Results;
35
36/**
37 * Channel provider interface.
38 *
39 * @category VuFind
40 * @package  Channels
41 * @author   Demian Katz <demian.katz@villanova.edu>
42 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
43 * @link     https://vufind.org/wiki/development Wiki
44 */
45interface ChannelProviderInterface
46{
47    /**
48     * Hook to configure search parameters before executing search.
49     *
50     * @param Params $params Search parameters to adjust
51     *
52     * @return void
53     */
54    public function configureSearchParams(Params $params);
55
56    /**
57     * Return channel information derived from a record driver object.
58     *
59     * @param RecordDriver $driver       Record driver
60     * @param string       $channelToken Token identifying a single specific channel
61     * to load (if omitted, all channels will be loaded)
62     *
63     * @return array
64     */
65    public function getFromRecord(RecordDriver $driver, $channelToken = null);
66
67    /**
68     * Return channel information derived from a search results object.
69     *
70     * @param Results $results      Search results
71     * @param string  $channelToken Token identifying a single specific channel
72     * to load (if omitted, all channels will be loaded)
73     *
74     * @return array
75     */
76    public function getFromSearch(Results $results, $channelToken = null);
77
78    /**
79     * Set the options for the provider.
80     *
81     * @param array $options Options
82     *
83     * @return void
84     */
85    public function setOptions(array $options);
86
87    /**
88     * Set an identifier that will be injected as the 'providerId' key of all
89     * channels created by this provider.
90     *
91     * @param string $id Provider ID
92     *
93     * @return void
94     */
95    public function setProviderId($id);
96}