Interface PluginInterface

Plugin Interface

Direct Implementers

Namespace: Cake\Core
Location: Core/PluginInterface.php

Constants summary

  • array

    VALID_HOOKS
    ['routes','bootstrap','console','middleware']

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
  • Get the filesystem path to configuration for this plugin
  • 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
  • isEnabled() public
    Check if the named hook is enabled
  • middleware() public
    Add middleware for the plugin.
  • routes() public
    Add routes for the plugin.

Method Detail

bootstrap()source public 

bootstrap( Cake\Core\PluginApplicationInterface $app )

Load 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

console()source public 

console( Cake\Console\CommandCollection $commands )

Add console commands for the plugin.

Parameters

Cake\Console\CommandCollection $commands
The command collection to update

Returns

Cake\Console\CommandCollection

disable()source public 

disable( string $hook )

Disables the named hook

Parameters

string $hook
The hook to disable

Returns


$this

enable()source public 

enable( string $hook )

Enables the named hook

Parameters

string $hook
The hook to disable

Returns


$this

getClassPath()source public 

getClassPath( )

Get the filesystem path to configuration for this plugin

Returns

string

getConfigPath()source public 

getConfigPath( )

Get the filesystem path to configuration for this plugin

Returns

string

getName()source public 

getName( )

Get the name of this plugin.

Returns

string

getPath()source public 

getPath( )

Get the filesystem path to this plugin

Returns

string

isEnabled()source public 

isEnabled( string $hook )

Check if the named hook is enabled

Parameters

string $hook
The hook to check

Returns

boolean

middleware()source public 

middleware( Cake\Http\MiddlewareQueue $middleware )

Add middleware for the plugin.

Parameters

Cake\Http\MiddlewareQueue $middleware
The middleware queue to update.

Returns

Cake\Http\MiddlewareQueue

routes()source public 

routes( Cake\Routing\RouteBuilder $routes )

Add 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.

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.6/class-Cake.Core.PluginInterface.html