Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
54.55% covered (warning)
54.55%
6 / 11
0.00% covered (danger)
0.00%
0 / 1
CRAP
0.00% covered (danger)
0.00%
0 / 1
SharedListenersTrait
54.55% covered (warning)
54.55%
6 / 11
0.00% covered (danger)
0.00%
0 / 1
7.35
0.00% covered (danger)
0.00%
0 / 1
 getHideFacetValueListener
54.55% covered (warning)
54.55%
6 / 11
0.00% covered (danger)
0.00%
0 / 1
7.35
1<?php
2
3/**
4 * Trait containing methods for building shared listeners.
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2022.
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  Search
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 Main Site
28 */
29
30namespace VuFind\Search\Factory;
31
32use Laminas\Config\Config;
33use VuFind\Search\Base\HideFacetValueListener;
34use VuFindSearch\Backend\BackendInterface;
35
36/**
37 * Trait containing methods for building shared listeners.
38 *
39 * @category VuFind
40 * @package  Search
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 Main Site
44 */
45trait SharedListenersTrait
46{
47    /**
48     * Get a hide facet value listener for the backend
49     *
50     * @param BackendInterface $backend Search backend
51     * @param Config           $facet   Configuration of facets
52     *
53     * @return mixed null|HideFacetValueListener
54     */
55    protected function getHideFacetValueListener(
56        BackendInterface $backend,
57        Config $facet
58    ) {
59        $hideFacetValue = isset($facet->HideFacetValue)
60            ? $facet->HideFacetValue->toArray() : [];
61        $showFacetValue = isset($facet->ShowFacetValue)
62            ? $facet->ShowFacetValue->toArray() : [];
63        if (empty($hideFacetValue) && empty($showFacetValue)) {
64            return null;
65        }
66        return new HideFacetValueListener(
67            $backend,
68            $hideFacetValue,
69            $showFacetValue
70        );
71    }
72}