Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00% covered (success)
100.00%
11 / 11
100.00% covered (success)
100.00%
3 / 3
CRAP
100.00% covered (success)
100.00%
1 / 1
AbstractPluginFactory
100.00% covered (success)
100.00%
11 / 11
100.00% covered (success)
100.00%
3 / 3
6
100.00% covered (success)
100.00%
1 / 1
 getClassName
100.00% covered (success)
100.00%
8 / 8
100.00% covered (success)
100.00%
1 / 1
4
 canCreate
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 __invoke
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
1
1<?php
2
3/**
4 * VuFind Abstract Plugin Factory
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2010.
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  ServiceManager
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\ServiceManager;
31
32use Laminas\ServiceManager\Factory\AbstractFactoryInterface;
33use Psr\Container\ContainerInterface;
34
35/**
36 * VuFind Abstract Plugin Factory
37 *
38 * @category VuFind
39 * @package  ServiceManager
40 * @author   Demian Katz <demian.katz@villanova.edu>
41 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
42 * @link     https://vufind.org/wiki/development Wiki
43 */
44abstract class AbstractPluginFactory implements AbstractFactoryInterface
45{
46    /**
47     * Default namespace for building class names
48     *
49     * @var string
50     */
51    protected $defaultNamespace;
52
53    /**
54     * Optional suffix to append to class names
55     *
56     * @var string
57     */
58    protected $classSuffix = '';
59
60    /**
61     * Get the name of a class for a given plugin name.
62     *
63     * @param string $requestedName Name of service
64     *
65     * @return string               Fully qualified class name
66     */
67    protected function getClassName($requestedName)
68    {
69        // If we have a FQCN that refers to an existing class, return it as-is:
70        if (str_contains($requestedName, '\\') && class_exists($requestedName)) {
71            return $requestedName;
72        }
73        // First try the raw service name, then try a normalized version:
74        $finalName = $this->defaultNamespace . '\\' . $requestedName
75            . $this->classSuffix;
76        if (!class_exists($finalName)) {
77            $finalName = $this->defaultNamespace . '\\'
78                . ucwords(strtolower($requestedName)) . $this->classSuffix;
79        }
80        return $finalName;
81    }
82
83    /**
84     * Can we create a service for the specified name?
85     *
86     * @param ContainerInterface $container     Service container
87     * @param string             $requestedName Name of service
88     *
89     * @return bool
90     *
91     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
92     */
93    public function canCreate(ContainerInterface $container, $requestedName)
94    {
95        return class_exists($this->getClassName($requestedName));
96    }
97
98    /**
99     * Create a service for the specified name.
100     *
101     * @param ContainerInterface $container     Service container
102     * @param string             $requestedName Name of service
103     * @param array              $options       Options (unused)
104     *
105     * @return object
106     *
107     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
108     */
109    public function __invoke(
110        ContainerInterface $container,
111        $requestedName,
112        array $options = null
113    ) {
114        $class = $this->getClassName($requestedName);
115        return new $class();
116    }
117}