Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
Total | |
0.00% |
0 / 9 |
|
0.00% |
0 / 2 |
CRAP | |
0.00% |
0 / 1 |
ApiControllerFactory | |
0.00% |
0 / 9 |
|
0.00% |
0 / 2 |
20 | |
0.00% |
0 / 1 |
__invoke | |
0.00% |
0 / 7 |
|
0.00% |
0 / 1 |
12 | |||
getApiControllersToRegister | |
0.00% |
0 / 2 |
|
0.00% |
0 / 1 |
2 |
1 | <?php |
2 | |
3 | /** |
4 | * Factory for ApiController. |
5 | * |
6 | * PHP version 8 |
7 | * |
8 | * Copyright (C) The National Library of Finland 2016-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 Controller |
25 | * @author Ere Maijala <ere.maijala@helsinki.fi> |
26 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
27 | * @link https://vufind.org/wiki/development:plugins:controllers Wiki |
28 | */ |
29 | |
30 | namespace VuFindApi\Controller; |
31 | |
32 | use Laminas\ServiceManager\Exception\ServiceNotCreatedException; |
33 | use Laminas\ServiceManager\Exception\ServiceNotFoundException; |
34 | use Laminas\ServiceManager\Factory\FactoryInterface; |
35 | use Psr\Container\ContainerExceptionInterface as ContainerException; |
36 | use Psr\Container\ContainerInterface; |
37 | |
38 | /** |
39 | * Factory for ApiController. |
40 | * |
41 | * @category VuFind |
42 | * @package Controller |
43 | * @author Ere Maijala <ere.maijala@helsinki.fi> |
44 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
45 | * @link https://vufind.org/wiki/development:plugins:controllers Wiki |
46 | */ |
47 | class ApiControllerFactory 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 | $controller = new $requestedName($container); |
72 | $controllerManager = $container->get('ControllerManager'); |
73 | foreach ($this->getApiControllersToRegister($container) as $apiName) { |
74 | $controller->addApi($controllerManager->get($apiName)); |
75 | } |
76 | return $controller; |
77 | } |
78 | |
79 | /** |
80 | * Get the API controllers to register with ApiController |
81 | * |
82 | * @param ContainerInterface $container Service manager |
83 | * |
84 | * @return array |
85 | */ |
86 | protected function getApiControllersToRegister(ContainerInterface $container) |
87 | { |
88 | $config = $container->get('Config'); |
89 | return $config['vufind_api']['register_controllers']; |
90 | } |
91 | } |