Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
Total | |
100.00% |
15 / 15 |
|
100.00% |
2 / 2 |
CRAP | |
100.00% |
1 / 1 |
GatewayFactory | |
100.00% |
15 / 15 |
|
100.00% |
2 / 2 |
4 | |
100.00% |
1 / 1 |
getRowPrototype | |
100.00% |
3 / 3 |
|
100.00% |
1 / 1 |
2 | |||
__invoke | |
100.00% |
12 / 12 |
|
100.00% |
1 / 1 |
2 |
1 | <?php |
2 | |
3 | /** |
4 | * Generic table gateway factory. |
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 Db_Table |
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 | |
30 | namespace VuFind\Db\Table; |
31 | |
32 | use Laminas\ServiceManager\Exception\ServiceNotCreatedException; |
33 | use Laminas\ServiceManager\Exception\ServiceNotFoundException; |
34 | use Psr\Container\ContainerExceptionInterface as ContainerException; |
35 | use Psr\Container\ContainerInterface; |
36 | |
37 | /** |
38 | * Generic table gateway factory. |
39 | * |
40 | * @category VuFind |
41 | * @package Db_Table |
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 | */ |
46 | class GatewayFactory implements \Laminas\ServiceManager\Factory\FactoryInterface |
47 | { |
48 | /** |
49 | * Return row prototype object (null if unavailable) |
50 | * |
51 | * @param ContainerInterface $container Service manager |
52 | * @param string $requestedName Service being created |
53 | * |
54 | * @return object |
55 | */ |
56 | protected function getRowPrototype(ContainerInterface $container, $requestedName) |
57 | { |
58 | $rowManager = $container->get(\VuFind\Db\Row\PluginManager::class); |
59 | // Map Table class to matching Row class. |
60 | $name = str_replace('\\Table\\', '\\Row\\', $requestedName); |
61 | return $rowManager->has($name) ? $rowManager->get($name) : null; |
62 | } |
63 | |
64 | /** |
65 | * Create an object |
66 | * |
67 | * @param ContainerInterface $container Service manager |
68 | * @param string $requestedName Service being created |
69 | * @param null|array $options Extra options (optional) |
70 | * |
71 | * @return object |
72 | * |
73 | * @throws ServiceNotFoundException if unable to resolve the service. |
74 | * @throws ServiceNotCreatedException if an exception is raised when |
75 | * creating a service. |
76 | * @throws ContainerException&\Throwable if any other error occurs |
77 | */ |
78 | public function __invoke( |
79 | ContainerInterface $container, |
80 | $requestedName, |
81 | array $options = null |
82 | ) { |
83 | $adapter = $container->get(\Laminas\Db\Adapter\Adapter::class); |
84 | $tm = $container->get(\VuFind\Db\Table\PluginManager::class); |
85 | $config = $container->get('config'); |
86 | $rowPrototype = $this->getRowPrototype($container, $requestedName); |
87 | $args = $options ? $options : []; |
88 | return new $requestedName( |
89 | $adapter, |
90 | $tm, |
91 | $config, |
92 | $rowPrototype, |
93 | ...$args |
94 | ); |
95 | } |
96 | } |