PluginClassLocator
extends
ShortNameLocator, IteratorAggregate
in
Plugin class locator interface
Table of Contents
Methods
- getClassName() : string
- Return full class name for a named helper
- getRegisteredPlugins() : array<string|int, mixed>|Traversable
- Get a list of all registered plugins
- isLoaded() : bool
- Whether or not a Helper by a specific name
- load() : string
- Load a helper via the name provided
- registerPlugin() : PluginClassLocator
- Register a class to a given short name
- unregisterPlugin() : void
- Unregister a short name lookup
Methods
getClassName()
Return full class name for a named helper
public
getClassName(string $name) : string
Parameters
- $name : string
Return values
stringgetRegisteredPlugins()
Get a list of all registered plugins
public
getRegisteredPlugins() : array<string|int, mixed>|Traversable
Return values
array<string|int, mixed>|TraversableisLoaded()
Whether or not a Helper by a specific name
public
isLoaded(string $name) : bool
Parameters
- $name : string
Return values
boolload()
Load a helper via the name provided
public
load(string $name) : string
Parameters
- $name : string
Return values
stringregisterPlugin()
Register a class to a given short name
public
registerPlugin(string $shortName, string $className) : PluginClassLocator
Parameters
- $shortName : string
- $className : string
Return values
PluginClassLocatorunregisterPlugin()
Unregister a short name lookup
public
unregisterPlugin(mixed $shortName) : void
Parameters
- $shortName : mixed