Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 12
0.00% covered (danger)
0.00%
0 / 1
CRAP
0.00% covered (danger)
0.00%
0 / 1
AbstractSyndeticsFactory
0.00% covered (danger)
0.00%
0 / 12
0.00% covered (danger)
0.00%
0 / 1
20
0.00% covered (danger)
0.00%
0 / 1
 __invoke
0.00% covered (danger)
0.00%
0 / 12
0.00% covered (danger)
0.00%
0 / 1
20
1<?php
2
3/**
4 * Generic Syndetics content plugin 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  Content
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\Content;
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;
37
38use function strlen;
39
40/**
41 * Generic Syndetics content plugin factory.
42 *
43 * @category VuFind
44 * @package  Content
45 * @author   Demian Katz <demian.katz@villanova.edu>
46 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
47 * @link     https://vufind.org/wiki/development Wiki
48 */
49class AbstractSyndeticsFactory implements FactoryInterface
50{
51    /**
52     * Create an object
53     *
54     * @param ContainerInterface $container     Service manager
55     * @param string             $requestedName Service being created
56     * @param null|array         $options       Extra options (optional)
57     *
58     * @return object
59     *
60     * @throws ServiceNotFoundException if unable to resolve the service.
61     * @throws ServiceNotCreatedException if an exception is raised when
62     * creating a service.
63     * @throws ContainerException&\Throwable if any other error occurs
64     */
65    public function __invoke(
66        ContainerInterface $container,
67        $requestedName,
68        array $options = null
69    ) {
70        if ($options !== null) {
71            throw new \Exception('Unexpected options sent to factory!');
72        }
73        $config = $container->get(\VuFind\Config\PluginManager::class)
74            ->get('config');
75
76        // Special case: if the class name ends in Plus, we need to strip off
77        // the "Plus" and instead configure the base Syndetics class into "plus"
78        // mode.
79        $plus = str_ends_with($requestedName, 'Plus');
80        $className = $plus
81            ? substr($requestedName, 0, strlen($requestedName) - 4) : $requestedName;
82
83        return new $className(
84            isset($config->Syndetics->use_ssl) && $config->Syndetics->use_ssl,
85            $plus,
86            $config->Syndetics->timeout ?? 10
87        );
88    }
89}