Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00% covered (success)
100.00%
6 / 6
100.00% covered (success)
100.00%
3 / 3
CRAP
100.00% covered (success)
100.00%
1 / 1
CollectionSideFacets
100.00% covered (success)
100.00%
6 / 6
100.00% covered (success)
100.00%
3 / 3
5
100.00% covered (success)
100.00%
1 / 1
 setConfig
100.00% covered (success)
100.00%
4 / 4
100.00% covered (success)
100.00%
1 / 1
3
 getKeywordFilter
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 keywordFilterEnabled
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
1<?php
2
3/**
4 * CollectionSideFacets Recommendations Module
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2010.
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
30namespace VuFind\Recommend;
31
32/**
33 * CollectionSideFacets Recommendations Module
34 *
35 * This class extends the SideFacets functionality for use in Collection display.
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 CollectionSideFacets extends SideFacets
44{
45    /**
46     * Is the keyword filter box active?
47     *
48     * @var bool
49     */
50    protected $keywordFilter = false;
51
52    /**
53     * Store the configuration of the recommendation module.
54     *
55     * @param string $settings Settings from searches.ini.
56     *
57     * @return void
58     */
59    public function setConfig($settings)
60    {
61        parent::setConfig($settings);
62
63        // Parse the additional settings:
64        $settings = explode(':', $settings);
65        if (isset($settings[3]) && $settings[3] !== 'false') {
66            $this->keywordFilter = true;
67        }
68    }
69
70    /**
71     * Get the current value of the keyword filter.
72     *
73     * @return string
74     */
75    public function getKeywordFilter()
76    {
77        return $this->results->getParams()->getDisplayQuery();
78    }
79
80    /**
81     * Is the keyword filter box enabled?
82     *
83     * @return bool
84     */
85    public function keywordFilterEnabled()
86    {
87        return $this->keywordFilter;
88    }
89}