Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 8
0.00% covered (danger)
0.00%
0 / 1
CRAP
0.00% covered (danger)
0.00%
0 / 1
AbstractBaseWithConfigFactory
0.00% covered (danger)
0.00%
0 / 8
0.00% covered (danger)
0.00%
0 / 1
6
0.00% covered (danger)
0.00%
0 / 1
 __invoke
0.00% covered (danger)
0.00%
0 / 8
0.00% covered (danger)
0.00%
0 / 1
6
1<?php
2
3/**
4 * Generic controller factory (with config injection).
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2018.
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  Controller
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\Controller;
31
32use Laminas\ServiceManager\Exception\ServiceNotCreatedException;
33use Laminas\ServiceManager\Exception\ServiceNotFoundException;
34use Psr\Container\ContainerExceptionInterface as ContainerException;
35use Psr\Container\ContainerInterface;
36
37/**
38 * Generic controller factory (with config injection).
39 *
40 * @category VuFind
41 * @package  Controller
42 * @author   Demian Katz <demian.katz@villanova.edu>
43 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
44 * @link     https://vufind.org/wiki/development Wiki
45 */
46class AbstractBaseWithConfigFactory extends AbstractBaseFactory
47{
48    /**
49     * Create an object
50     *
51     * @param ContainerInterface $container     Service manager
52     * @param string             $requestedName Service being created
53     * @param null|array         $options       Extra options (optional)
54     *
55     * @return object
56     *
57     * @throws ServiceNotFoundException if unable to resolve the service.
58     * @throws ServiceNotCreatedException if an exception is raised when
59     * creating a service.
60     * @throws ContainerException&\Throwable if any other error occurs
61     */
62    public function __invoke(
63        ContainerInterface $container,
64        $requestedName,
65        array $options = null
66    ) {
67        if (!empty($options)) {
68            throw new \Exception('Unexpected options sent to factory.');
69        }
70        $config = $container->get(\VuFind\Config\PluginManager::class)
71            ->get('config');
72        return $this->applyPermissions(
73            $container,
74            new $requestedName($container, $config)
75        );
76    }
77}