Class PluginCollection
Plugin Collection
Holds onto plugin objects loaded into an application, and provides methods for iterating, and finding plugins based on criteria.
This class implements the Iterator interface to allow plugins to be iterated, handling the situation where a plugin's hook method (usually bootstrap) loads another plugin during iteration.
While its implementation supported nested iteration it does not
support using continue or break inside loops.
Property Summary
-
$loopDepth protected
intLoop depth
-
$names protected
list<string>Names of plugins
-
$plugins protected
array<Cake\Core\PluginInterface>Plugin list
-
$positions protected
array<int>Iterator position stack.
Method Summary
-
__construct() public
Constructor
-
add() public
Add a plugin to the collection
-
addFromConfig() public
Add plugins from config array.
-
clear() public
Remove all plugins from the collection
-
count() public
Implementation of Countable.
-
create() public
Create a plugin instance from a name/classname and configuration.
-
current() public
Part of Iterator Interface
-
findPath() public
Locate a plugin path by looking at configuration data.
-
get() public
Get the a plugin by name.
-
has() public
Check whether the named plugin exists in the collection.
-
key() public
Part of Iterator Interface
-
next() public
Part of Iterator Interface
-
remove() public
Remove a plugin from the collection if it exists.
-
rewind() public
Part of Iterator Interface
-
valid() public
Part of Iterator Interface
-
with() public
Filter the plugins to those with the named hook enabled.
Method Detail
__construct() ¶ public
__construct(array<Cake\Core\PluginInterface> $plugins = [])Constructor
Parameters
-
array<Cake\Core\PluginInterface>$plugins optional The map of plugins to add to the collection.
add() ¶ public
add(Cake\Core\PluginInterface $plugin): $thisAdd a plugin to the collection
Plugins will be keyed by their names.
Parameters
-
Cake\Core\PluginInterface$plugin The plugin to load.
Returns
$thisaddFromConfig() ¶ public
addFromConfig(array $config): voidAdd plugins from config array.
Parameters
-
array$config Configuration array. For e.g.:
[ 'Company/TestPluginThree', 'TestPlugin' => ['onlyDebug' => true, 'onlyCli' => true], 'Nope' => ['optional' => true], 'Named' => ['routes' => false, 'bootstrap' => false], ]
Returns
voidcount() ¶ public
count(): intImplementation of Countable.
Get the number of plugins in the collection.
Returns
intcreate() ¶ public
create(string $name, array<string, mixed> $config = []): Cake\Core\PluginInterfaceCreate a plugin instance from a name/classname and configuration.
Parameters
-
string$name The plugin name or classname
-
array<string, mixed>$config optional Configuration options for the plugin.
Returns
Cake\Core\PluginInterfaceThrows
Cake\Core\Exception\MissingPluginExceptionWhen plugin instance could not be created.
InvalidArgumentExceptionWhen class name cannot be found.
current() ¶ public
current(): Cake\Core\PluginInterfacePart of Iterator Interface
Returns
Cake\Core\PluginInterfacefindPath() ¶ public
findPath(string $name): stringLocate a plugin path by looking at configuration data.
This will use the plugins Configure key, and fallback to enumerating App::path('plugins')
This method is not part of the official public API as plugins with no plugin class are being phased out.
Parameters
-
string$name The plugin name to locate a path for.
Returns
stringThrows
Cake\Core\Exception\MissingPluginExceptionwhen a plugin path cannot be resolved.
get() ¶ public
get(string $name): Cake\Core\PluginInterfaceGet the a plugin by name.
If a plugin isn't already loaded it will be autoloaded on first access and that plugins loaded this way may miss some hook methods.
Parameters
-
string$name The plugin to get.
Returns
Cake\Core\PluginInterfaceThrows
Cake\Core\Exception\MissingPluginExceptionwhen unknown plugins are fetched.
has() ¶ public
has(string $name): boolCheck whether the named plugin exists in the collection.
Parameters
-
string$name The named plugin.
Returns
boolremove() ¶ public
remove(string $name): $thisRemove a plugin from the collection if it exists.
Parameters
-
string$name The named plugin.
Returns
$thiswith() ¶ public
with(string $hook): Generator<Cake\Core\PluginInterface>Filter the plugins to those with the named hook enabled.
Parameters
-
string$hook The hook to filter plugins by
Returns
Generator<Cake\Core\PluginInterface>Throws
InvalidArgumentExceptionon invalid hooks