PluginManager
extends AbstractPluginManager
in package
AJAX handler plugin manager
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
= ['checkRequestIsValid' => \VuFind\AjaxHandler\CheckRequestIsValid::class, 'commentRecord' => \VuFind\AjaxHandler\CommentRecord::class, 'deleteRecordComment' => \VuFind\AjaxHandler\DeleteRecordComment::class, 'doiLookup' => \VuFind\AjaxHandler\DoiLookup::class, 'getACSuggestions' => \VuFind\AjaxHandler\GetACSuggestions::class, 'getIlsStatus' => \VuFind\AjaxHandler\GetIlsStatus::class, 'getItemStatuses' => \VuFind\AjaxHandler\GetItemStatuses::class, 'getLibraryPickupLocations' => \VuFind\AjaxHandler\GetLibraryPickupLocations::class, 'getRecordCommentsAsHTML' => \VuFind\AjaxHandler\GetRecordCommentsAsHTML::class, 'getRecordCover' => \VuFind\AjaxHandler\GetRecordCover::class, 'getRecordDetails' => \VuFind\AjaxHandler\GetRecordDetails::class, 'getRecordRating' => \VuFind\AjaxHandler\GetRecordRating::class, 'getRecordTags' => \VuFind\AjaxHandler\GetRecordTags::class, 'getRecordVersions' => \VuFind\AjaxHandler\GetRecordVersions::class, 'getRequestGroupPickupLocations' => \VuFind\AjaxHandler\GetRequestGroupPickupLocations::class, 'getResolverLinks' => \VuFind\AjaxHandler\GetResolverLinks::class, 'getResultCount' => \VuFind\AjaxHandler\GetResultCount::class, 'getSaveStatuses' => \VuFind\AjaxHandler\GetSaveStatuses::class, 'getSearchResults' => \VuFind\AjaxHandler\GetSearchResults::class, 'getSideFacets' => \VuFind\AjaxHandler\GetSideFacets::class, 'getUserFines' => \VuFind\AjaxHandler\GetUserFines::class, 'getUserHolds' => \VuFind\AjaxHandler\GetUserHolds::class, 'getUserILLRequests' => \VuFind\AjaxHandler\GetUserILLRequests::class, 'getUserStorageRetrievalRequests' => \VuFind\AjaxHandler\GetUserStorageRetrievalRequests::class, 'getUserTransactions' => \VuFind\AjaxHandler\GetUserTransactions::class, 'getVisData' => \VuFind\AjaxHandler\GetVisData::class, 'keepAlive' => \VuFind\AjaxHandler\KeepAlive::class, 'recommend' => \VuFind\AjaxHandler\Recommend::class, 'relaisAvailability' => \VuFind\AjaxHandler\RelaisAvailability::class, 'relaisInfo' => \VuFind\AjaxHandler\RelaisInfo::class, 'relaisOrder' => \VuFind\AjaxHandler\RelaisOrder::class, 'systemStatus' => \VuFind\AjaxHandler\SystemStatus::class, 'tagRecord' => \VuFind\AjaxHandler\TagRecord::class]
$factories
Default plugin factories.
protected
array<string|int, mixed>
$factories
= [\VuFind\AjaxHandler\CheckRequestIsValid::class => \VuFind\AjaxHandler\AbstractIlsAndUserActionFactory::class, \VuFind\AjaxHandler\CommentRecord::class => \VuFind\AjaxHandler\CommentRecordFactory::class, \VuFind\AjaxHandler\DeleteRecordComment::class => \VuFind\AjaxHandler\DeleteRecordCommentFactory::class, \VuFind\AjaxHandler\DoiLookup::class => \VuFind\AjaxHandler\DoiLookupFactory::class, \VuFind\AjaxHandler\GetACSuggestions::class => \VuFind\AjaxHandler\GetACSuggestionsFactory::class, \VuFind\AjaxHandler\GetIlsStatus::class => \VuFind\AjaxHandler\GetIlsStatusFactory::class, \VuFind\AjaxHandler\GetItemStatuses::class => \VuFind\AjaxHandler\GetItemStatusesFactory::class, \VuFind\AjaxHandler\GetLibraryPickupLocations::class => \VuFind\AjaxHandler\AbstractIlsAndUserActionFactory::class, \VuFind\AjaxHandler\GetRecordCommentsAsHTML::class => \VuFind\AjaxHandler\GetRecordCommentsAsHTMLFactory::class, \VuFind\AjaxHandler\GetRecordCover::class => \VuFind\AjaxHandler\GetRecordCoverFactory::class, \VuFind\AjaxHandler\GetRecordDetails::class => \VuFind\AjaxHandler\GetRecordDetailsFactory::class, \VuFind\AjaxHandler\GetRecordRating::class => \VuFind\AjaxHandler\GetRecordRatingFactory::class, \VuFind\AjaxHandler\GetRecordTags::class => \VuFind\AjaxHandler\GetRecordTagsFactory::class, \VuFind\AjaxHandler\GetRecordVersions::class => \VuFind\AjaxHandler\GetRecordVersionsFactory::class, \VuFind\AjaxHandler\GetRequestGroupPickupLocations::class => \VuFind\AjaxHandler\AbstractIlsAndUserActionFactory::class, \VuFind\AjaxHandler\GetResolverLinks::class => \VuFind\AjaxHandler\GetResolverLinksFactory::class, \VuFind\AjaxHandler\GetResultCount::class => \VuFind\AjaxHandler\GetResultCountFactory::class, \VuFind\AjaxHandler\GetSaveStatuses::class => \VuFind\AjaxHandler\GetSaveStatusesFactory::class, \VuFind\AjaxHandler\GetSearchResults::class => \VuFind\AjaxHandler\GetSearchResultsFactory::class, \VuFind\AjaxHandler\GetSideFacets::class => \VuFind\AjaxHandler\GetSideFacetsFactory::class, \VuFind\AjaxHandler\GetUserFines::class => \VuFind\AjaxHandler\GetUserFinesFactory::class, \VuFind\AjaxHandler\GetUserHolds::class => \VuFind\AjaxHandler\AbstractIlsAndUserActionFactory::class, \VuFind\AjaxHandler\GetUserILLRequests::class => \VuFind\AjaxHandler\AbstractIlsAndUserActionFactory::class, \VuFind\AjaxHandler\GetUserStorageRetrievalRequests::class => \VuFind\AjaxHandler\AbstractIlsAndUserActionFactory::class, \VuFind\AjaxHandler\GetUserTransactions::class => \VuFind\AjaxHandler\AbstractIlsAndUserActionFactory::class, \VuFind\AjaxHandler\GetVisData::class => \VuFind\AjaxHandler\GetVisDataFactory::class, \VuFind\AjaxHandler\KeepAlive::class => \VuFind\AjaxHandler\KeepAliveFactory::class, \VuFind\AjaxHandler\Recommend::class => \VuFind\AjaxHandler\RecommendFactory::class, \VuFind\AjaxHandler\RelaisAvailability::class => \VuFind\AjaxHandler\AbstractRelaisActionFactory::class, \VuFind\AjaxHandler\RelaisInfo::class => \VuFind\AjaxHandler\AbstractRelaisActionFactory::class, \VuFind\AjaxHandler\RelaisOrder::class => \VuFind\AjaxHandler\AbstractRelaisActionFactory::class, \VuFind\AjaxHandler\SystemStatus::class => \VuFind\AjaxHandler\SystemStatusFactory::class, \VuFind\AjaxHandler\TagRecord::class => \VuFind\AjaxHandler\TagRecordFactory::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