BackendRegistry
extends AbstractPluginManager
in package
Registry for search backends.
Tags
Table of Contents
- $aliases : array<string|int, mixed>
- Default plugin aliases.
- $factories : array<string|int, mixed>
- Default plugin factories.
- __construct() : mixed
- Constructor
- get() : mixed
- Retrieve a plugin
- has() : bool
- Returns true if the container can return an entry for the given identifier.
- validate() : void
- Validate the plugin
- getExpectedInterface() : string
- Return the name of the base class or interface that plug-ins must conform to.
- getNormalizedServiceName() : string
- Hack for backward compatibility with services defined under ServiceManager v2, when service names were case-insensitive.
Properties
$aliases
Default plugin aliases.
protected
array<string|int, mixed>
$aliases
= [
// Allow Solr core names to be used as aliases for services:
'authority' => 'SolrAuth',
'biblio' => 'Solr',
'reserves' => 'SolrReserves',
// Legacy:
'VuFind' => 'Solr',
]
$factories
Default plugin factories.
protected
array<string|int, mixed>
$factories
= ['Blender' => \VuFind\Search\Factory\BlenderBackendFactory::class, 'BrowZine' => \VuFind\Search\Factory\BrowZineBackendFactory::class, 'EDS' => \VuFind\Search\Factory\EdsBackendFactory::class, 'EIT' => \VuFind\Search\Factory\EITBackendFactory::class, 'EPF' => \VuFind\Search\Factory\EPFBackendFactory::class, 'LibGuides' => \VuFind\Search\Factory\LibGuidesBackendFactory::class, 'LibGuidesAZ' => \VuFind\Search\Factory\LibGuidesAZBackendFactory::class, 'Pazpar2' => \VuFind\Search\Factory\Pazpar2BackendFactory::class, 'Primo' => \VuFind\Search\Factory\PrimoBackendFactory::class, 'Search2' => \VuFind\Search\Factory\Search2BackendFactory::class, 'Search2Collection' => \VuFind\Search\Factory\Search2BackendFactory::class, 'Solr' => \VuFind\Search\Factory\SolrDefaultBackendFactory::class, 'SolrAuth' => \VuFind\Search\Factory\SolrAuthBackendFactory::class, 'SolrReserves' => \VuFind\Search\Factory\SolrReservesBackendFactory::class, 'SolrWeb' => \VuFind\Search\Factory\SolrWebBackendFactory::class, 'Summon' => \VuFind\Search\Factory\SummonBackendFactory::class, 'WorldCat' => \VuFind\Search\Factory\WorldCatBackendFactory::class]
Methods
__construct()
Constructor
public
__construct([mixed $configOrContainerInstance = null ][, array<string|int, mixed> $v3config = [] ]) : mixed
Make sure plugins are properly initialized.
Parameters
- $configOrContainerInstance : mixed = null
-
Configuration or container instance
- $v3config : array<string|int, mixed> = []
-
If $configOrContainerInstance is a container, this value will be passed to the parent constructor.
Return values
mixed —get()
Retrieve a plugin
public
get(string $name[, null|array<string|int, mixed> $options = null ]) : mixed
Parameters
- $name : string
-
Name of plugin
- $options : null|array<string|int, mixed> = null
-
Options to use when creating the instance.
Return values
mixed —has()
Returns true if the container can return an entry for the given identifier.
public
has(string $id) : bool
Returns false otherwise.
Parameters
- $id : string
-
Identifier of the entry to look for.
Return values
bool —validate()
Validate the plugin
public
validate(mixed $plugin) : void
Checks that the filter loaded is either a valid callback or an instance of FilterInterface.
Parameters
- $plugin : mixed
-
Plugin to validate
Tags
Return values
void —getExpectedInterface()
Return the name of the base class or interface that plug-ins must conform to.
protected
getExpectedInterface() : string
Return values
string —getNormalizedServiceName()
Hack for backward compatibility with services defined under ServiceManager v2, when service names were case-insensitive.
protected
getNormalizedServiceName(string $name) : string
TODO: set up aliases and/or normalize code to eliminate the need for this.
Parameters
- $name : string
-
Service name