Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 31
0.00% covered (danger)
0.00%
0 / 5
 CRAP
0.00% covered (danger)
0.00%
0 / 1
Pazpar2BackendFactory
0.00% covered (danger)
0.00%
0 / 31
0.00% covered (danger)
0.00%
0 / 5
 72
0.00% covered (danger)
0.00%
0 / 1
 __invoke
0.00% covered (danger)
0.00%
0 / 7
0.00% covered (danger)
0.00%
0 / 1
 6
 createBackend
0.00% covered (danger)
0.00%
0 / 10
0.00% covered (danger)
0.00%
0 / 1
 12
 createConnector
0.00% covered (danger)
0.00%
0 / 6
0.00% covered (danger)
0.00%
0 / 1
 2
 createQueryBuilder
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
 2
 createRecordCollectionFactory
0.00% covered (danger)
0.00%
0 / 7
0.00% covered (danger)
0.00%
0 / 1
 2
1<?php
2
3/**
4 * Factory for Pazpar2 backends.
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2013.
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   David Maus <maus@hab.de>
26 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
27 * @link     https://vufind.org Main Site
28 */
29
30namespace VuFind\Search\Factory;
31
32use Psr\Container\ContainerInterface;
33use VuFindSearch\Backend\Pazpar2\Backend;
34use VuFindSearch\Backend\Pazpar2\Connector;
35use VuFindSearch\Backend\Pazpar2\QueryBuilder;
36use VuFindSearch\Backend\Pazpar2\Response\RecordCollectionFactory;
37
38/**
39 * Factory for Pazpar2 backends.
40 *
41 * @category VuFind
42 * @package  Search
43 * @author   David Maus <maus@hab.de>
44 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
45 * @link     https://vufind.org Main Site
46 */
47class Pazpar2BackendFactory extends AbstractBackendFactory
48{
49    /**
50     * Logger.
51     *
52     * @var \Laminas\Log\LoggerInterface
53     */
54    protected $logger;
55
56    /**
57     * VuFind configuration
58     *
59     * @var \Laminas\Config\Config
60     */
61    protected $config;
62
63    /**
64     * Create service
65     *
66     * @param ContainerInterface $sm      Service manager
67     * @param string             $name    Requested service name (unused)
68     * @param array              $options Extra options (unused)
69     *
70     * @return Backend
71     *
72     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
73     */
74    public function __invoke(ContainerInterface $sm, $name, array $options = null)
75    {
76        $this->setup($sm);
77        $this->config = $this->getService(\VuFind\Config\PluginManager::class)->get('Pazpar2');
78        if ($this->serviceLocator->has(\VuFind\Log\Logger::class)) {
79            $this->logger = $this->getService(\VuFind\Log\Logger::class);
80        }
81        $connector = $this->createConnector();
82        $backend   = $this->createBackend($connector);
83        return $backend;
84    }
85
86    /**
87     * Create the Pazpar2 backend.
88     *
89     * @param Connector $connector Connector
90     *
91     * @return Backend
92     */
93    protected function createBackend(Connector $connector)
94    {
95        $backend = new Backend($connector, $this->createRecordCollectionFactory());
96        $backend->setLogger($this->logger);
97        $backend->setQueryBuilder($this->createQueryBuilder());
98        if (isset($this->config->General->max_query_time)) {
99            $backend->setMaxQueryTime($this->config->General->max_query_time);
100        }
101        if (isset($this->config->General->progress_target)) {
102            $backend->setSearchProgressTarget(
103                $this->config->General->progress_target
104            );
105        }
106        return $backend;
107    }
108
109    /**
110     * Create the Pazpar2 connector.
111     *
112     * @return Connector
113     */
114    protected function createConnector()
115    {
116        $connector = new Connector(
117            $this->config->General->base_url,
118            $this->createHttpClient()
119        );
120        $connector->setLogger($this->logger);
121        return $connector;
122    }
123
124    /**
125     * Create the Pazpar2 query builder.
126     *
127     * @return QueryBuilder
128     */
129    protected function createQueryBuilder()
130    {
131        return new QueryBuilder();
132    }
133
134    /**
135     * Create the record collection factory
136     *
137     * @return RecordCollectionFactory
138     */
139    protected function createRecordCollectionFactory()
140    {
141        $manager = $this->getService(\VuFind\RecordDriver\PluginManager::class);
142        $callback = function ($data) use ($manager) {
143            $driver = $manager->get('Pazpar2');
144            $driver->setRawData($data);
145            return $driver;
146        };
147        return new RecordCollectionFactory($callback);
148    }
149}