PluginManager
extends AbstractPluginManager
in package
Record driver plugin manager
Tags
Table of Contents
- $aliases : array<string|int, mixed>
- Default plugin aliases.
- $delegators : array<string|int, array<string|int, string>>|array<string|int, array<string|int, DelegatorFactoryInterface>>
- Default delegator factories.
- $factories : array<string|int, mixed>
- Default plugin factories.
- __construct() : mixed
- Constructor
- get() : mixed
- Retrieve a plugin
- getSearch2Record() : AbstractBase
- Convenience method to retrieve a populated Search2 record driver.
- getSolrAuthRecord() : AbstractBase
- Convenience method to retrieve a populated Solr authority record driver.
- getSolrRecord() : AbstractBase
- Convenience method to retrieve a populated Solr record driver.
- 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
= [
'browzine' => \VuFind\RecordDriver\BrowZine::class,
'eds' => \VuFind\RecordDriver\EDS::class,
'eit' => \VuFind\RecordDriver\EIT::class,
'epf' => \VuFind\RecordDriver\EPF::class,
'libguides' => \VuFind\RecordDriver\LibGuides::class,
'libguidesaz' => \VuFind\RecordDriver\LibGuidesAZ::class,
'missing' => \VuFind\RecordDriver\Missing::class,
'pazpar2' => \VuFind\RecordDriver\Pazpar2::class,
'primo' => \VuFind\RecordDriver\Primo::class,
'search2default' => \VuFind\RecordDriver\Search2Default::class,
'solrarchivesspace' => \VuFind\RecordDriver\SolrArchivesSpace::class,
'solrauth' => \VuFind\RecordDriver\SolrAuthMarc::class,
// legacy name
'solrauthdefault' => \VuFind\RecordDriver\SolrAuthDefault::class,
'solrauthmarc' => \VuFind\RecordDriver\SolrAuthMarc::class,
'solrdefault' => \VuFind\RecordDriver\SolrDefault::class,
'solrmarc' => \VuFind\RecordDriver\SolrMarc::class,
'solrmarcremote' => \VuFind\RecordDriver\SolrMarcRemote::class,
'solroverdrive' => \VuFind\RecordDriver\SolrOverdrive::class,
'solrreserves' => \VuFind\RecordDriver\SolrReserves::class,
'solrweb' => \VuFind\RecordDriver\SolrWeb::class,
'summon' => \VuFind\RecordDriver\Summon::class,
'worldcat' => \VuFind\RecordDriver\WorldCat::class,
]
$delegators
Default delegator factories.
protected
array<string|int, array<string|int, string>>|array<string|int, array<string|int, DelegatorFactoryInterface>>
$delegators
= [\VuFind\RecordDriver\SolrMarc::class => [\VuFind\RecordDriver\IlsAwareDelegatorFactory::class], \VuFind\RecordDriver\SolrMarcRemote::class => [\VuFind\RecordDriver\IlsAwareDelegatorFactory::class]]
$factories
Default plugin factories.
protected
array<string|int, mixed>
$factories
= [\VuFind\RecordDriver\BrowZine::class => \Laminas\ServiceManager\Factory\InvokableFactory::class, \VuFind\RecordDriver\EDS::class => \VuFind\RecordDriver\NameBasedConfigFactory::class, \VuFind\RecordDriver\EIT::class => \VuFind\RecordDriver\NameBasedConfigFactory::class, \VuFind\RecordDriver\EPF::class => \VuFind\RecordDriver\NameBasedConfigFactory::class, \VuFind\RecordDriver\LibGuides::class => \Laminas\ServiceManager\Factory\InvokableFactory::class, \VuFind\RecordDriver\LibGuidesAZ::class => \Laminas\ServiceManager\Factory\InvokableFactory::class, \VuFind\RecordDriver\Missing::class => \VuFind\RecordDriver\AbstractBaseFactory::class, \VuFind\RecordDriver\Pazpar2::class => \VuFind\RecordDriver\NameBasedConfigFactory::class, \VuFind\RecordDriver\Primo::class => \VuFind\RecordDriver\NameBasedConfigFactory::class, \VuFind\RecordDriver\Search2Default::class => \VuFind\RecordDriver\Search2DefaultFactory::class, \VuFind\RecordDriver\SolrArchivesSpace::class => \VuFind\RecordDriver\SolrDefaultFactory::class, \VuFind\RecordDriver\SolrAuthDefault::class => \VuFind\RecordDriver\SolrDefaultWithoutSearchServiceFactory::class, \VuFind\RecordDriver\SolrAuthMarc::class => \VuFind\RecordDriver\SolrDefaultWithoutSearchServiceFactory::class, \VuFind\RecordDriver\SolrDefault::class => \VuFind\RecordDriver\SolrDefaultFactory::class, \VuFind\RecordDriver\SolrMarc::class => \VuFind\RecordDriver\SolrDefaultFactory::class, \VuFind\RecordDriver\SolrMarcRemote::class => \VuFind\RecordDriver\SolrDefaultFactory::class, \VuFind\RecordDriver\SolrOverdrive::class => \VuFind\RecordDriver\SolrOverdriveFactory::class, \VuFind\RecordDriver\SolrReserves::class => \VuFind\RecordDriver\SolrDefaultWithoutSearchServiceFactory::class, \VuFind\RecordDriver\SolrWeb::class => \VuFind\RecordDriver\SolrWebFactory::class, \VuFind\RecordDriver\Summon::class => \VuFind\RecordDriver\SummonFactory::class, \VuFind\RecordDriver\WorldCat::class => \VuFind\RecordDriver\NameBasedConfigFactory::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 —getSearch2Record()
Convenience method to retrieve a populated Search2 record driver.
public
getSearch2Record(array<string|int, mixed> $data[, string $defaultKeySuffix = 'Default' ]) : AbstractBase
Parameters
- $data : array<string|int, mixed>
-
Raw Solr data
- $defaultKeySuffix : string = 'Default'
-
Default key suffix
Return values
AbstractBase —getSolrAuthRecord()
Convenience method to retrieve a populated Solr authority record driver.
public
getSolrAuthRecord(array<string|int, mixed> $data) : AbstractBase
Parameters
- $data : array<string|int, mixed>
-
Raw Solr data
Return values
AbstractBase —getSolrRecord()
Convenience method to retrieve a populated Solr record driver.
public
getSolrRecord(array<string|int, mixed> $data[, string $keyPrefix = 'Solr' ][, string $defaultKeySuffix = 'Default' ]) : AbstractBase
Parameters
- $data : array<string|int, mixed>
-
Raw Solr data
- $keyPrefix : string = 'Solr'
-
Record class name prefix
- $defaultKeySuffix : string = 'Default'
-
Default key suffix
Return values
AbstractBase —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