Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00% covered (success)
100.00%
11 / 11
100.00% covered (success)
100.00%
2 / 2
CRAP
100.00% covered (success)
100.00%
1 / 1
ParentTemplate
100.00% covered (success)
100.00%
11 / 11
100.00% covered (success)
100.00%
2 / 2
7
100.00% covered (success)
100.00%
1 / 1
 __construct
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 __invoke
100.00% covered (success)
100.00%
10 / 10
100.00% covered (success)
100.00%
1 / 1
6
1<?php
2
3/**
4 * Helper to get path to a parent template (for including)
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2019.
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   Chris Hallberg <challber@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 VuFindTheme\View\Helper;
31
32use Exception;
33use Laminas\View\Resolver\TemplatePathStack;
34
35/**
36 * Helper to get path to a parent template (for including)
37 *
38 * @category VuFind
39 * @package  View_Helpers
40 * @author   Chris Hallberg <challber@villanova.edu>
41 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
42 * @link     https://vufind.org/wiki/development Wiki
43 */
44class ParentTemplate extends \Laminas\View\Helper\AbstractHelper
45{
46    /**
47     * Inheritance stack of template folder paths
48     *
49     * @var TemplatePathStack
50     */
51    protected $templatePathStack;
52
53    /**
54     * Constructor
55     *
56     * @param TemplatePathStack $templateStack Inheritance stack of template paths
57     */
58    public function __construct($templateStack)
59    {
60        $this->templatePathStack = $templateStack;
61    }
62
63    /**
64     * Returns an template path according the configured theme
65     *
66     * @param string $template    template name like 'footer.phtml'
67     * @param string $targetTheme specific parent to inherit from
68     *
69     * @return string path, null if image not found
70     * @throws Exception if no file exists at path
71     */
72    public function __invoke($template, $targetTheme = null)
73    {
74        $paths = $this->templatePathStack->getPaths();
75
76        // rewind to fix problems with multiple invokes
77        $paths->rewind();
78        // skip current theme
79        $paths->next();
80
81        while (
82            $paths->current() &&
83            (!file_exists($paths->current() . $template) ||
84            (!empty($targetTheme) && !strstr($paths->current(), $targetTheme)))
85        ) {
86            $paths->next();
87        }
88        if ($paths->current() == null) {
89            throw new \Exception('not found in parent themes: ' . $template);
90        }
91        return $paths->current() . $template;
92    }
93}