Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 2
CRAP
0.00% covered (danger)
0.00%
0 / 1
JsIcons
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 2
6
0.00% covered (danger)
0.00%
0 / 1
 __construct
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 1
2
 mapValue
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
1<?php
2
3/**
4 * JsIcons helper for passing icon HTML to Javascript
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2021.
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  View_Helpers
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\View\Helper\Root;
31
32/**
33 * JsIcons helper for passing icon HTML to Javascript
34 *
35 * @category VuFind
36 * @package  View_Helpers
37 * @author   Chris Hallberg <challber@villanova.edu>
38 * @author   Demian Katz <demian.katz@villanova.edu>
39 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
40 * @link     https://vufind.org/wiki/development Wiki
41 */
42class JsIcons extends AbstractJsStrings
43{
44    /**
45     * Icon helper
46     *
47     * @var Icon
48     */
49    protected $iconHelper;
50
51    /**
52     * Constructor
53     *
54     * @param Icon   $iconHelper Icon helper
55     * @param string $varName    Variable name to store icons
56     */
57    public function __construct(
58        Icon $iconHelper,
59        $varName = 'vufindIconString'
60    ) {
61        parent::__construct($varName);
62        $this->iconHelper = $iconHelper;
63    }
64
65    /**
66     * Generate Icon from string
67     *
68     * @param string $icon String to transform
69     * @param string $key  JSON object key
70     *
71     * @return string
72     *
73     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
74     */
75    protected function mapValue($icon, string $key): string
76    {
77        return ($this->iconHelper)($icon);
78    }
79}