Interface PluginInterface
Plugin Interface
Constants
-
array<string>VALID_HOOKS ¶['bootstrap', 'console', 'middleware', 'routes', 'services']List of valid hooks.
Method Summary
-
bootstrap() public
Load all the application configuration and bootstrap logic.
-
console() public
Add console commands for the plugin.
-
disable() public
Disables the named hook
-
enable() public
Enables the named hook
-
getClassPath() public
Get the filesystem path to configuration for this plugin
-
getConfigPath() public
Get the filesystem path to configuration for this plugin
-
getName() public
Get the name of this plugin.
-
getPath() public
Get the filesystem path to this plugin
-
getTemplatePath() public
Get the filesystem path to templates for this plugin
-
isEnabled() public
Check if the named hook is enabled
-
middleware() public
Add middleware for the plugin.
-
routes() public
Add routes for the plugin.
-
services() public
Register plugin services to the application's container
Method Detail
bootstrap() ¶ public
bootstrap(Cake\Core\PluginApplicationInterface $app): voidLoad all the application configuration and bootstrap logic.
The default implementation of this method will include the config/bootstrap.php in the plugin if it exist. You
can override this method to replace that behavior.
The host application is provided as an argument. This allows you to load additional plugin dependencies, or attach events.
Parameters
-
Cake\Core\PluginApplicationInterface$app The host application
Returns
voidconsole() ¶ public
console(Cake\Console\CommandCollection $commands): Cake\Console\CommandCollectionAdd console commands for the plugin.
Parameters
-
Cake\Console\CommandCollection$commands The command collection to update
Returns
Cake\Console\CommandCollectiondisable() ¶ public
disable(string $hook): $thisDisables the named hook
Parameters
-
string$hook The hook to disable
Returns
$thisenable() ¶ public
enable(string $hook): $thisEnables the named hook
Parameters
-
string$hook The hook to disable
Returns
$thisgetClassPath() ¶ public
getClassPath(): stringGet the filesystem path to configuration for this plugin
Returns
stringgetConfigPath() ¶ public
getConfigPath(): stringGet the filesystem path to configuration for this plugin
Returns
stringgetTemplatePath() ¶ public
getTemplatePath(): stringGet the filesystem path to templates for this plugin
Returns
stringisEnabled() ¶ public
isEnabled(string $hook): boolCheck if the named hook is enabled
Parameters
-
string$hook The hook to check
Returns
boolmiddleware() ¶ public
middleware(Cake\Http\MiddlewareQueue $middlewareQueue): Cake\Http\MiddlewareQueueAdd middleware for the plugin.
Parameters
-
Cake\Http\MiddlewareQueue$middlewareQueue The middleware queue to update.
Returns
Cake\Http\MiddlewareQueueroutes() ¶ public
routes(Cake\Routing\RouteBuilder $routes): voidAdd routes for the plugin.
The default implementation of this method will include the config/routes.php in the plugin if it exists. You
can override this method to replace that behavior.
Parameters
-
Cake\Routing\RouteBuilder$routes The route builder to update.
Returns
voidservices() ¶ public
services(Cake\Core\ContainerInterface $container): voidRegister plugin services to the application's container
Parameters
-
Cake\Core\ContainerInterface$container Container instance.
Returns
void