Interface PluginApplicationInterface
Interface for Applications that leverage plugins & events.
Events can be bound to the application event manager during the application's bootstrap and plugin bootstrap.
Method Summary
-
addPlugin() public
Add a plugin to the loaded plugin set.
-
dispatchEvent() public
Wrapper for creating and dispatching events.
-
getEventManager() public
Returns the Cake\Event\EventManager manager instance for this object.
-
pluginBootstrap() public
Run bootstrap logic for loaded plugins.
-
pluginConsole() public
Run console hooks for plugins
-
pluginMiddleware() public
Run middleware hooks for plugins
-
pluginRoutes() public
Run routes hooks for loaded plugins
-
setEventManager() public
Sets the Cake\Event\EventManager manager instance for this object.
Method Detail
addPlugin() ¶ public
addPlugin(Cake\Core\PluginInterface|string $name, array<string, mixed> $config = []): $thisAdd a plugin to the loaded plugin set.
If the named plugin does not exist, or does not define a Plugin class, an
instance of Cake\Core\BasePlugin will be used. This generated class will have
all plugin hooks enabled.
Parameters
-
Cake\Core\PluginInterface|string$name The plugin name or plugin object.
-
array<string, mixed>$config optional The configuration data for the plugin if using a string for $name
Returns
$thisdispatchEvent() ¶ public
dispatchEvent(string $name, array|null $data = null, object|null $subject = null): Cake\Event\EventInterfaceWrapper for creating and dispatching events.
Returns a dispatched event.
Parameters
-
string$name Name of the event.
-
array|null$data optional Any value you wish to be transported with this event to it can be read by listeners.
-
object|null$subject optional The object that this event applies to ($this by default).
Returns
Cake\Event\EventInterfacegetEventManager() ¶ public
getEventManager(): Cake\Event\EventManagerInterfaceReturns the Cake\Event\EventManager manager instance for this object.
Returns
Cake\Event\EventManagerInterfacepluginBootstrap() ¶ public
pluginBootstrap(): voidRun bootstrap logic for loaded plugins.
Returns
voidpluginConsole() ¶ public
pluginConsole(Cake\Console\CommandCollection $commands): Cake\Console\CommandCollectionRun console hooks for plugins
Parameters
-
Cake\Console\CommandCollection$commands The CommandCollection to use.
Returns
Cake\Console\CommandCollectionpluginMiddleware() ¶ public
pluginMiddleware(Cake\Http\MiddlewareQueue $middleware): Cake\Http\MiddlewareQueueRun middleware hooks for plugins
Parameters
-
Cake\Http\MiddlewareQueue$middleware The MiddlewareQueue to use.
Returns
Cake\Http\MiddlewareQueuepluginRoutes() ¶ public
pluginRoutes(Cake\Routing\RouteBuilder $routes): Cake\Routing\RouteBuilderRun routes hooks for loaded plugins
Parameters
-
Cake\Routing\RouteBuilder$routes The route builder to use.
Returns
Cake\Routing\RouteBuildersetEventManager() ¶ public
setEventManager(Cake\Event\EventManagerInterface $eventManager): $thisSets the Cake\Event\EventManager manager instance for this object.
You can use this instance to register any new listeners or callbacks to the object events, or create your own events and trigger them at will.
Parameters
-
Cake\Event\EventManagerInterface$eventManager the eventManager to set
Returns
$this