Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
1 / 1
CRAP
100.00% covered (success)
100.00%
1 / 1
TransEsc
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
1 / 1
 __invoke
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
1 / 1
1
1<?php
2
3/**
4 * Translate + escape view helper
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  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
32use Laminas\View\Helper\AbstractHelper;
33
34/**
35 * Translate + escape view helper
36 *
37 * @category VuFind
38 * @package  View_Helpers
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 Wiki
42 */
43class TransEsc extends AbstractHelper
44{
45    /**
46     * Translate and escape a string
47     *
48     * @param string|object|array $str             String to translate or an array of text
49     *                                             domain and string to translate
50     * @param array               $tokens          Tokens to inject into the translated string
51     * @param string              $default         Default value to use if no translation is
52     *                                             found (null for no default).
53     * @param bool                $useIcuFormatter Should we use an ICU message formatter instead
54     * of the default behavior?
55     * @param string[]            $fallbackDomains Text domains to check if no match is found in
56     * the domain specified in $target
57     *
58     * @return string
59     */
60    public function __invoke(
61        $str,
62        $tokens = [],
63        $default = null,
64        $useIcuFormatter = false,
65        $fallbackDomains = []
66    ) {
67        $escaper = $this->getView()->plugin('escapeHtml');
68        $translator = $this->getView()->plugin('translate');
69        return $escaper($translator($str, $tokens, $default, $useIcuFormatter, $fallbackDomains));
70    }
71}