CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Team
    • Issues (Github)
    • YouTube Channel
    • Get Involved
    • Bakery
    • Featured Resources
    • Newsletter
    • Certification
    • My CakePHP
    • CakeFest
    • Facebook
    • Twitter
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.8 Red Velvet API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 3.8
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Cake
    • Auth
      • Storage
    • Cache
      • Engine
    • Collection
      • Iterator
    • Command
    • Console
      • Exception
    • Controller
      • Component
      • Exception
    • Core
      • Configure
        • Engine
      • Exception
      • Retry
    • Database
      • Driver
      • Exception
      • Expression
      • Schema
      • Statement
      • Type
    • Datasource
      • Exception
    • Error
      • Middleware
    • Event
      • Decorator
    • Filesystem
    • Form
    • Http
      • Client
        • Adapter
        • Auth
      • Cookie
      • Exception
      • Middleware
      • Session
    • I18n
      • Formatter
      • Middleware
      • Parser
    • Log
      • Engine
    • Mailer
      • Exception
      • Transport
    • Network
      • Exception
    • ORM
      • Association
      • Behavior
        • Translate
      • Exception
      • Locator
      • Rule
    • Routing
      • Exception
      • Filter
      • Middleware
      • Route
    • Shell
      • Helper
      • Task
    • TestSuite
      • Fixture
      • Stub
    • Utility
      • Exception
    • Validation
    • View
      • Exception
      • Form
      • Helper
      • Widget
  • None

Classes

  • App
  • BasePlugin
  • ClassLoader
  • Configure
  • ObjectRegistry
  • Plugin
  • PluginCollection

Interfaces

  • ConsoleApplicationInterface
  • HttpApplicationInterface
  • PluginApplicationInterface
  • PluginInterface

Traits

  • ConventionsTrait
  • InstanceConfigTrait
  • StaticConfigTrait

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.

Cake\Core\PluginApplicationInterface implements Cake\Event\EventDispatcherInterface
Direct Implementers
  • Cake\Http\BaseApplication
Namespace: Cake\Core
Location: Core/PluginApplicationInterface.php

Method Summary

  • addPlugin() public
    Add a plugin to the loaded plugin set.
  • 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

Method Detail

addPlugin() public ¶

addPlugin( string|Cake\Core\PluginInterface $name , array $config = [] )

Add 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
string|Cake\Core\PluginInterface $name
The plugin name or plugin object.
array $config optional []
The configuration data for the plugin if using a string for $name
Returns

$this

pluginBootstrap() public ¶

pluginBootstrap( )

Run bootstrap logic for loaded plugins.

pluginConsole() public ¶

pluginConsole( Cake\Console\CommandCollection $commands )

Run console hooks for plugins

Parameters
Cake\Console\CommandCollection $commands
The CommandCollection to use.
Returns
Cake\Console\CommandCollection

pluginMiddleware() public ¶

pluginMiddleware( Cake\Http\MiddlewareQueue $middleware )

Run middleware hooks for plugins

Parameters
Cake\Http\MiddlewareQueue $middleware
The MiddlewareQueue to use.
Returns
Cake\Http\MiddlewareQueue

pluginRoutes() public ¶

pluginRoutes( Cake\Routing\RouteBuilder $routes )

Run routes hooks for loaded plugins

Parameters
Cake\Routing\RouteBuilder $routes
The route builder to use.
Returns
Cake\Routing\RouteBuilder

Magic methods inherited from Cake\Event\EventDispatcherInterface

getEventManager()
Follow @CakePHP
#IRC
OpenHub
Rackspace
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Logos & Trademarks
  • Community
  • Team
  • Issues (Github)
  • YouTube Channel
  • Get Involved
  • Bakery
  • Featured Resources
  • Newsletter
  • Certification
  • My CakePHP
  • CakeFest
  • Facebook
  • Twitter
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs