PluginManager
extends AbstractPluginManager
in package
Session handler 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
- 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
= [
'database' => \VuFind\Session\Database::class,
'file' => \VuFind\Session\File::class,
'memcache' => \VuFind\Session\Memcache::class,
'redis' => \VuFind\Session\Redis::class,
// for legacy 1.x compatibility
'filesession' => \VuFind\Session\File::class,
'memcachesession' => \VuFind\Session\Memcache::class,
'mysqlsession' => \VuFind\Session\Database::class,
]
$delegators
Default delegator factories.
protected
array<string|int, array<string|int, string>>|array<string|int, array<string|int, DelegatorFactoryInterface>>
$delegators
= [\VuFind\Session\Database::class => [\VuFind\Session\SecureDelegatorFactory::class], \VuFind\Session\File::class => [\VuFind\Session\SecureDelegatorFactory::class], \VuFind\Session\Memcache::class => [\VuFind\Session\SecureDelegatorFactory::class], \VuFind\Session\Redis::class => [\VuFind\Session\SecureDelegatorFactory::class]]
$factories
Default plugin factories.
protected
array<string|int, mixed>
$factories
= [\VuFind\Session\Database::class => \VuFind\Session\AbstractBaseFactory::class, \VuFind\Session\File::class => \VuFind\Session\AbstractBaseFactory::class, \VuFind\Session\Memcache::class => \VuFind\Session\AbstractBaseFactory::class, \VuFind\Session\Redis::class => \VuFind\Session\RedisFactory::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