Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 7
0.00% covered (danger)
0.00%
0 / 3
CRAP
0.00% covered (danger)
0.00%
0 / 1
TrendingILSItems
0.00% covered (danger)
0.00%
0 / 7
0.00% covered (danger)
0.00%
0 / 3
30
0.00% covered (danger)
0.00%
0 / 1
 setOptions
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
6
 getIlsResponse
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
6
 extractIdsFromResponse
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
1<?php
2
3/**
4 * "Trending ILS items" channel provider.
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2018.
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
32/**
33 * "Trending ILS items" channel provider.
34 *
35 * @category VuFind
36 * @package  Channels
37 * @author   Demian Katz <demian.katz@villanova.edu>
38 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
39 * @link     https://vufind.org/wiki/development Wiki
40 */
41class TrendingILSItems extends AbstractILSChannelProvider
42{
43    /**
44     * Channel title (will be run through translator).
45     *
46     * @var string
47     */
48    protected $channelTitle = 'trending_items_channel_title';
49
50    /**
51     * Set the options for the provider.
52     *
53     * @param array $options Options
54     *
55     * @return void
56     */
57    public function setOptions(array $options)
58    {
59        // Use higher default age for trending.
60        if (!isset($options['maxAge'])) {
61            $options['maxAge'] = 90;
62        }
63        parent::setOptions($options);
64    }
65
66    /**
67     * Retrieve data from the ILS.
68     *
69     * @return array
70     */
71    protected function getIlsResponse()
72    {
73        return $this->ils->checkCapability('getTrendingBibs')
74            ? $this->ils->getTrendingBibs($this->channelSize, $this->maxAge)
75            : [];
76    }
77
78    /**
79     * Given one element from the ILS function's response array, extract the
80     * ID value.
81     *
82     * @param array $response Response array
83     *
84     * @return string
85     */
86    protected function extractIdsFromResponse($response)
87    {
88        return $response['id'];
89    }
90}