Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
70.59% |
12 / 17 |
|
0.00% |
0 / 1 |
CRAP | |
0.00% |
0 / 1 |
| ParamsFactory | |
70.59% |
12 / 17 |
|
0.00% |
0 / 1 |
3.23 | |
0.00% |
0 / 1 |
| __invoke | |
70.59% |
12 / 17 |
|
0.00% |
0 / 1 |
3.23 | |||
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * Generic factory for search params objects. |
| 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 Search |
| 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\Search\Params; |
| 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 | * Generic factory for search params objects. |
| 40 | * |
| 41 | * @category VuFind |
| 42 | * @package Search |
| 43 | * @author Demian Katz <demian.katz@villanova.edu> |
| 44 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
| 45 | * @link https://vufind.org/wiki/development Wiki |
| 46 | */ |
| 47 | class ParamsFactory 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 | // Replace trailing "Params" with "Options" to get the options service: |
| 69 | $optionsService = preg_replace('/Params$/', 'Options', $requestedName); |
| 70 | // Replace leading namespace with "VuFind" if service is not available: |
| 71 | $optionsServiceAvailable = $container |
| 72 | ->get(\VuFind\Search\Options\PluginManager::class)->has($optionsService); |
| 73 | if (!$optionsServiceAvailable) { |
| 74 | $optionsService = preg_replace( |
| 75 | '/^[^\\\]+/', |
| 76 | 'VuFind', |
| 77 | $optionsService |
| 78 | ); |
| 79 | } |
| 80 | $optionsObj = $container->get(\VuFind\Search\Options\PluginManager::class) |
| 81 | ->get($optionsService); |
| 82 | $configLoader = $container->get(\VuFind\Config\PluginManager::class); |
| 83 | // Clone the options instance in case caller modifies it: |
| 84 | return new $requestedName( |
| 85 | clone $optionsObj, |
| 86 | $configLoader, |
| 87 | ...($options ?: []) |
| 88 | ); |
| 89 | } |
| 90 | } |