Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
93.75% covered (success)
93.75%
15 / 16
0.00% covered (danger)
0.00%
0 / 1
CRAP
0.00% covered (danger)
0.00%
0 / 1
InjectTemplateListenerFactory
93.75% covered (success)
93.75%
15 / 16
0.00% covered (danger)
0.00%
0 / 1
4.00
0.00% covered (danger)
0.00%
0 / 1
 __invoke
93.75% covered (success)
93.75%
15 / 16
0.00% covered (danger)
0.00%
0 / 1
4.00
1<?php
2
3/**
4 * Factory for InjectTemplateListener
5 *
6 * PHP version 8
7 *
8 * Copyright (C) 2019 Leipzig University Library
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 as
12 * 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 along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 *
23 * @category VuFind
24 * @package  Theme
25 * @author   Sebastian Kehr <kehr@ub.uni-leipzig.de>
26 * @license  http://opensource.org/licenses/gpl-2.0.php GNU GPLv2
27 * @link     https://vufind.org Main Site
28 */
29
30namespace VuFindTheme;
31
32use Laminas\ServiceManager\Exception\ServiceNotCreatedException;
33use Laminas\ServiceManager\Exception\ServiceNotFoundException;
34use Laminas\ServiceManager\Factory\FactoryInterface;
35use Psr\Container\ContainerExceptionInterface as ContainerException;
36use Psr\Container\ContainerInterface;
37
38/**
39 * Factory for InjectTemplateListener
40 *
41 * @category VuFind
42 * @package  Theme
43 * @author   Sebastian Kehr <kehr@ub.uni-leipzig.de>
44 * @license  http://opensource.org/licenses/gpl-2.0.php GNU GPLv2
45 * @link     https://vufind.org Main Site
46 */
47class InjectTemplateListenerFactory implements FactoryInterface
48{
49    /**
50     * Create an object
51     *
52     * @param ContainerInterface $container     Service manager
53     * @param string             $requestedName Service being created
54     * @param null|array         $options       Extra options (optional)
55     *
56     * @return object
57     *
58     * @throws ServiceNotFoundException if unable to resolve the service.
59     * @throws ServiceNotCreatedException if an exception is raised when
60     * creating a service.
61     * @throws ContainerException&\Throwable if any other error occurs
62     */
63    public function __invoke(
64        ContainerInterface $container,
65        $requestedName,
66        array $options = null
67    ) {
68        if (!empty($options)) {
69            throw new \Exception('Unexpected options sent to factory.');
70        }
71        $config = $container->get('config');
72        $prefixes = $config['vufind']['extra_theme_prefixes'] ?? [];
73        $exclude = $config['vufind']['excluded_theme_prefixes'] ?? [];
74
75        // we assume that - by default - modules try loading templates from
76        // their own namespace, thus all loaded modules are included for inflection
77        $modules = array_map(
78            function ($module) {
79                return str_replace('\\', '/', $module) . '/';
80            },
81            $container->get('ModuleManager')->getModules()
82        );
83        $prefixes = array_filter(
84            array_merge($prefixes, $modules),
85            function ($prefix) use ($exclude) {
86                foreach ($exclude as $current) {
87                    if (str_starts_with($prefix, $current)) {
88                        return false;
89                    }
90                }
91                return true;
92            }
93        );
94
95        return new $requestedName(array_unique($prefixes));
96    }
97}