Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00% covered (success)
100.00%
4 / 4
100.00% covered (success)
100.00%
2 / 2
CRAP
100.00% covered (success)
100.00%
1 / 1
FavoriteFacets
100.00% covered (success)
100.00%
4 / 4
100.00% covered (success)
100.00%
2 / 2
3
100.00% covered (success)
100.00%
1 / 1
 __construct
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
1
 setConfig
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
2
1<?php
2
3/**
4 * FavoriteFacets 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 * FavoriteFacets Recommendations Module
34 *
35 * This class provides special facets for the Favorites area (tags/lists)
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 FavoriteFacets extends SideFacets
44{
45    /**
46     * Tag capability setting
47     *
48     * @var string
49     */
50    protected $tagSetting;
51
52    /**
53     * Constructor
54     *
55     * @param \VuFind\Config\PluginManager $configLoader Configuration loader
56     * @param string                       $tagSetting   Tag capability setting
57     */
58    public function __construct(
59        \VuFind\Config\PluginManager $configLoader,
60        $tagSetting = 'enabled'
61    ) {
62        parent::__construct($configLoader);
63        $this->tagSetting = $tagSetting;
64    }
65
66    /**
67     * Store the configuration of the recommendation module.
68     *
69     * @param string $settings Settings from searches.ini.
70     *
71     * @return void
72     */
73    public function setConfig($settings)
74    {
75        // Only display tags when enabled:
76        $this->mainFacets = ($this->tagSetting !== 'disabled')
77            ? ['tags' => 'Your Tags'] : [];
78    }
79}