VuFind API Documentation

PluginManager extends AbstractPluginManager
in package

Recommendation module plugin manager

Tags
category

VuFind

author

Demian Katz demian.katz@villanova.edu

license

http://opensource.org/licenses/gpl-2.0.php GNU General Public License

link

Wiki

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 = ['alphabrowselink' => \VuFind\Recommend\AlphaBrowseLink::class, 'authorfacets' => \VuFind\Recommend\AuthorFacets::class, 'authorinfo' => \VuFind\Recommend\AuthorInfo::class, 'authorityrecommend' => \VuFind\Recommend\AuthorityRecommend::class, 'catalogresults' => \VuFind\Recommend\CatalogResults::class, 'channels' => \VuFind\Recommend\Channels::class, 'collectionsidefacets' => \VuFind\Recommend\CollectionSideFacets::class, 'consortialvufind' => \VuFind\Recommend\ConsortialVuFind::class, 'consortialvufinddeferred' => \VuFind\Recommend\ConsortialVuFindDeferred::class, 'databases' => \VuFind\Recommend\Databases::class, 'doi' => \VuFind\Recommend\DOI::class, 'dplaterms' => \VuFind\Recommend\DPLATerms::class, 'edsresults' => \VuFind\Recommend\EDSResults::class, 'edsresultsdeferred' => \VuFind\Recommend\EDSResultsDeferred::class, 'epfresults' => \VuFind\Recommend\EPFResults::class, 'epfresultsdeferred' => \VuFind\Recommend\EPFResultsDeferred::class, 'europeanaresults' => \VuFind\Recommend\EuropeanaResults::class, 'europeanaresultsdeferred' => \VuFind\Recommend\EuropeanaResultsDeferred::class, 'expandfacets' => \VuFind\Recommend\ExpandFacets::class, 'externalsearch' => \VuFind\Recommend\ExternalSearch::class, 'facetcloud' => \VuFind\Recommend\FacetCloud::class, 'favoritefacets' => \VuFind\Recommend\FavoriteFacets::class, 'libguidesprofile' => \VuFind\Recommend\LibGuidesProfile::class, 'libguidesresults' => \VuFind\Recommend\LibGuidesResults::class, 'libguidesresultsdeferred' => \VuFind\Recommend\LibGuidesResultsDeferred::class, 'libguidesazresults' => \VuFind\Recommend\LibGuidesAZResults::class, 'libguidesazresultsdeferred' => \VuFind\Recommend\LibGuidesAZResultsDeferred::class, 'libraryh3lp' => \VuFind\Recommend\Libraryh3lp::class, 'mapselection' => \VuFind\Recommend\MapSelection::class, 'sidefacets' => \VuFind\Recommend\SideFacets::class, 'sidefacetsdeferred' => \VuFind\Recommend\SideFacetsDeferred::class, 'openlibrarysubjects' => \VuFind\Recommend\OpenLibrarySubjects::class, 'openlibrarysubjectsdeferred' => \VuFind\Recommend\OpenLibrarySubjectsDeferred::class, 'pubdatevisajax' => \VuFind\Recommend\PubDateVisAjax::class, 'randomrecommend' => \VuFind\Recommend\RandomRecommend::class, 'recommendlinks' => \VuFind\Recommend\RecommendLinks::class, 'removefilters' => \VuFind\Recommend\RemoveFilters::class, 'resultgooglemapajax' => \VuFind\Recommend\Deprecated::class, 'spellingsuggestions' => \VuFind\Recommend\SpellingSuggestions::class, 'summonbestbets' => \VuFind\Recommend\SummonBestBets::class, 'summonbestbetsdeferred' => \VuFind\Recommend\SummonBestBetsDeferred::class, 'summondatabases' => \VuFind\Recommend\SummonDatabases::class, 'summondatabasesdeferred' => \VuFind\Recommend\SummonDatabasesDeferred::class, 'summonresults' => \VuFind\Recommend\SummonResults::class, 'summonresultsdeferred' => \VuFind\Recommend\SummonResultsDeferred::class, 'summontopics' => \VuFind\Recommend\SummonTopics::class, 'switchquery' => \VuFind\Recommend\SwitchQuery::class, 'switchtype' => \VuFind\Recommend\SwitchType::class, 'topfacets' => \VuFind\Recommend\TopFacets::class, 'visualfacets' => \VuFind\Recommend\VisualFacets::class, 'webresults' => \VuFind\Recommend\WebResults::class, 'worldcatidentities' => \VuFind\Recommend\Deprecated::class, 'worldcatterms' => \VuFind\Recommend\Deprecated::class]

$factories

Default plugin factories.

protected array<string|int, mixed> $factories = [\VuFind\Recommend\AlphaBrowseLink::class => \Laminas\ServiceManager\Factory\InvokableFactory::class, \VuFind\Recommend\AuthorFacets::class => \VuFind\Recommend\InjectResultsManagerFactory::class, \VuFind\Recommend\AuthorInfo::class => \VuFind\Recommend\AuthorInfoFactory::class, \VuFind\Recommend\AuthorityRecommend::class => \VuFind\Recommend\InjectResultsManagerFactory::class, \VuFind\Recommend\CatalogResults::class => \VuFind\Recommend\AbstractSearchObjectFactory::class, \VuFind\Recommend\Channels::class => \Laminas\ServiceManager\Factory\InvokableFactory::class, \VuFind\Recommend\CollectionSideFacets::class => \VuFind\Recommend\CollectionSideFacetsFactory::class, \VuFind\Recommend\ConsortialVuFind::class => \VuFind\Recommend\ConsortialVuFindFactory::class, \VuFind\Recommend\ConsortialVuFindDeferred::class => \Laminas\ServiceManager\Factory\InvokableFactory::class, \VuFind\Recommend\Databases::class => \VuFind\Recommend\DatabasesFactory::class, \VuFind\Recommend\Deprecated::class => \Laminas\ServiceManager\Factory\InvokableFactory::class, \VuFind\Recommend\DOI::class => \Laminas\ServiceManager\Factory\InvokableFactory::class, \VuFind\Recommend\DPLATerms::class => \VuFind\Recommend\DPLATermsFactory::class, \VuFind\Recommend\EDSResults::class => \VuFind\Recommend\AbstractSearchObjectFactory::class, \VuFind\Recommend\EDSResultsDeferred::class => \Laminas\ServiceManager\Factory\InvokableFactory::class, \VuFind\Recommend\EPFResults::class => \VuFind\Recommend\AbstractSearchObjectFactory::class, \VuFind\Recommend\EPFResultsDeferred::class => \Laminas\ServiceManager\Factory\InvokableFactory::class, \VuFind\Recommend\EuropeanaResults::class => \VuFind\Recommend\EuropeanaResultsFactory::class, \VuFind\Recommend\EuropeanaResultsDeferred::class => \Laminas\ServiceManager\Factory\InvokableFactory::class, \VuFind\Recommend\ExpandFacets::class => \VuFind\Recommend\ExpandFacetsFactory::class, \VuFind\Recommend\ExternalSearch::class => \Laminas\ServiceManager\Factory\InvokableFactory::class, \VuFind\Recommend\FacetCloud::class => \VuFind\Recommend\ExpandFacetsFactory::class, \VuFind\Recommend\FavoriteFacets::class => \VuFind\Recommend\FavoriteFacetsFactory::class, \VuFind\Recommend\LibGuidesProfile::class => \VuFind\Recommend\LibGuidesProfileFactory::class, \VuFind\Recommend\LibGuidesResults::class => \VuFind\Recommend\AbstractSearchObjectFactory::class, \VuFind\Recommend\LibGuidesResultsDeferred::class => \Laminas\ServiceManager\Factory\InvokableFactory::class, \VuFind\Recommend\LibGuidesAZResults::class => \VuFind\Recommend\AbstractSearchObjectFactory::class, \VuFind\Recommend\LibGuidesAZResultsDeferred::class => \Laminas\ServiceManager\Factory\InvokableFactory::class, \VuFind\Recommend\Libraryh3lp::class => \Laminas\ServiceManager\Factory\InvokableFactory::class, \VuFind\Recommend\MapSelection::class => \VuFind\Recommend\MapSelectionFactory::class, \VuFind\Recommend\OpenLibrarySubjects::class => \Laminas\ServiceManager\Factory\InvokableFactory::class, \VuFind\Recommend\OpenLibrarySubjectsDeferred::class => \Laminas\ServiceManager\Factory\InvokableFactory::class, \VuFind\Recommend\PubDateVisAjax::class => \Laminas\ServiceManager\Factory\InvokableFactory::class, \VuFind\Recommend\RandomRecommend::class => \VuFind\Recommend\RandomRecommendFactory::class, \VuFind\Recommend\RecommendLinks::class => \VuFind\Recommend\InjectConfigManagerFactory::class, \VuFind\Recommend\RemoveFilters::class => \Laminas\ServiceManager\Factory\InvokableFactory::class, \VuFind\Recommend\SideFacets::class => \VuFind\Recommend\SideFacetsFactory::class, \VuFind\Recommend\SideFacetsDeferred::class => \VuFind\Recommend\SideFacetsFactory::class, \VuFind\Recommend\SpellingSuggestions::class => \Laminas\ServiceManager\Factory\InvokableFactory::class, \VuFind\Recommend\SummonBestBets::class => \VuFind\Recommend\InjectResultsManagerFactory::class, \VuFind\Recommend\SummonBestBetsDeferred::class => \Laminas\ServiceManager\Factory\InvokableFactory::class, \VuFind\Recommend\SummonDatabases::class => \VuFind\Recommend\InjectResultsManagerFactory::class, \VuFind\Recommend\SummonDatabasesDeferred::class => \Laminas\ServiceManager\Factory\InvokableFactory::class, \VuFind\Recommend\SummonResults::class => \VuFind\Recommend\AbstractSearchObjectFactory::class, \VuFind\Recommend\SummonResultsDeferred::class => \Laminas\ServiceManager\Factory\InvokableFactory::class, \VuFind\Recommend\SummonTopics::class => \VuFind\Recommend\InjectResultsManagerFactory::class, \VuFind\Recommend\SwitchQuery::class => \VuFind\Recommend\SwitchQueryFactory::class, \VuFind\Recommend\SwitchType::class => \Laminas\ServiceManager\Factory\InvokableFactory::class, \VuFind\Recommend\TopFacets::class => \VuFind\Recommend\InjectConfigManagerFactory::class, \VuFind\Recommend\VisualFacets::class => \VuFind\Recommend\InjectConfigManagerFactory::class, \VuFind\Recommend\WebResults::class => \VuFind\Recommend\AbstractSearchObjectFactory::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
throws
InvalidServiceException

if invalid

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

Return values
string —

Search results