Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
2 / 2
CRAP
100.00% covered (success)
100.00%
1 / 1
PluginManager
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
2 / 2
2
100.00% covered (success)
100.00%
1 / 1
 __construct
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
1
 getExpectedInterface
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
1<?php
2
3/**
4 * Autocomplete handler plugin manager
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2010-2023.
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  Autocomplete
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:plugins:autosuggesters Wiki
28 */
29
30namespace VuFind\Autocomplete;
31
32use Laminas\ServiceManager\Factory\InvokableFactory;
33
34/**
35 * Autocomplete handler plugin manager
36 *
37 * @category VuFind
38 * @package  Autocomplete
39 * @author   Demian Katz <demian.katz@villanova.edu>
40 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
41 * @link     https://vufind.org/wiki/development:plugins:autosuggesters Wiki
42 */
43class PluginManager extends \VuFind\ServiceManager\AbstractPluginManager
44{
45    /**
46     * Default plugin aliases.
47     *
48     * @var array
49     */
50    protected $aliases = [
51        'none' => None::class,
52        'eds' => Eds::class,
53        'oclcidentities' => None::class,
54        'search2' => Search2::class,
55        'search2cn' => Search2CN::class,
56        'solr' => Solr::class,
57        'solrauth' => SolrAuth::class,
58        'solrcn' => SolrCN::class,
59        'solrreserves' => SolrReserves::class,
60        'tag' => Tag::class,
61        'solrprefix' => SolrPrefix::class,
62        // for legacy 1.x compatibility
63        'noautocomplete' => 'None',
64        'oclcidentitiesautocomplete' => 'None',
65        'solrautocomplete' => 'Solr',
66        'solrauthautocomplete' => 'SolrAuth',
67        'solrcnautocomplete' => 'SolrCN',
68        'solrreservesautocomplete' => 'SolrReserves',
69        'tagautocomplete' => 'Tag',
70    ];
71
72    /**
73     * Default plugin factories.
74     *
75     * @var array
76     */
77    protected $factories = [
78        None::class => InvokableFactory::class,
79        Eds::class => EdsFactory::class,
80        Search2::class => SolrFactory::class,
81        Search2CN::class => SolrFactory::class,
82        Solr::class => SolrFactory::class,
83        SolrAuth::class => SolrFactory::class,
84        SolrCN::class => SolrFactory::class,
85        SolrReserves::class => SolrFactory::class,
86        Tag::class => TagFactory::class,
87        SolrPrefix::class => SolrFactory::class,
88    ];
89
90    /**
91     * Constructor
92     *
93     * Make sure plugins are properly initialized.
94     *
95     * @param mixed $configOrContainerInstance Configuration or container instance
96     * @param array $v3config                  If $configOrContainerInstance is a
97     * container, this value will be passed to the parent constructor.
98     */
99    public function __construct(
100        $configOrContainerInstance = null,
101        array $v3config = []
102    ) {
103        $this->addAbstractFactory(PluginFactory::class);
104        parent::__construct($configOrContainerInstance, $v3config);
105    }
106
107    /**
108     * Return the name of the base class or interface that plug-ins must conform
109     * to.
110     *
111     * @return string
112     */
113    protected function getExpectedInterface()
114    {
115        return AutocompleteInterface::class;
116    }
117}