Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
94.74% covered (success)
94.74%
18 / 19
0.00% covered (danger)
0.00%
0 / 1
CRAP
0.00% covered (danger)
0.00%
0 / 1
ResultsFactory
94.74% covered (success)
94.74%
18 / 19
0.00% covered (danger)
0.00%
0 / 1
3.00
0.00% covered (danger)
0.00%
0 / 1
 __invoke
94.74% covered (success)
94.74%
18 / 19
0.00% covered (danger)
0.00%
0 / 1
3.00
1<?php
2
3/**
4 * Generic factory for search results 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
30namespace VuFind\Search\Results;
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;
37use VuFind\Search\Factory\UrlQueryHelperFactory;
38
39/**
40 * Generic factory for search results objects.
41 *
42 * @category VuFind
43 * @package  Search
44 * @author   Demian Katz <demian.katz@villanova.edu>
45 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
46 * @link     https://vufind.org/wiki/development Wiki
47 */
48class ResultsFactory implements FactoryInterface
49{
50    /**
51     * Create an object
52     *
53     * @param ContainerInterface $container     Service manager
54     * @param string             $requestedName Service being created
55     * @param null|array         $options       Extra options (optional)
56     *
57     * @return object
58     *
59     * @throws ServiceNotFoundException if unable to resolve the service.
60     * @throws ServiceNotCreatedException if an exception is raised when
61     * creating a service.
62     * @throws ContainerException&\Throwable if any other error occurs
63     */
64    public function __invoke(
65        ContainerInterface $container,
66        $requestedName,
67        array $options = null
68    ) {
69        // Replace trailing "Results" with "Params" to get the params service:
70        $paramsService = preg_replace('/Results$/', 'Params', $requestedName);
71        // Replace leading namespace with "VuFind" if service is not available:
72        $paramsServiceAvailable = $container
73            ->get(\VuFind\Search\Params\PluginManager::class)->has($paramsService);
74        if (!$paramsServiceAvailable) {
75            $paramsService = preg_replace('/^[^\\\]+/', 'VuFind', $paramsService);
76        }
77        $params = $container->get(\VuFind\Search\Params\PluginManager::class)
78            ->get($paramsService);
79        $searchService = $container->get(\VuFindSearch\Service::class);
80        $recordLoader = $container->get(\VuFind\Record\Loader::class);
81        $results = new $requestedName(
82            $params,
83            $searchService,
84            $recordLoader,
85            ...($options ?: [])
86        );
87        $results->setUrlQueryHelperFactory(
88            $container->get(UrlQueryHelperFactory::class)
89        );
90        return $results;
91    }
92}