CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 4.3 Strawberry API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 4.3
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 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

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Command
    • Console
    • Controller
    • Core
      • Configure
      • Exception
      • Retry
    • Database
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • Http
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

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.

Namespace: Cake\Core

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 = []): $this

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
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
$this

dispatchEvent() ¶ public

dispatchEvent(string $name, array|null $data = null, object|null $subject = null): Cake\Event\EventInterface

Wrapper 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\EventInterface

getEventManager() ¶ public

getEventManager(): Cake\Event\EventManagerInterface

Returns the Cake\Event\EventManager manager instance for this object.

Returns
Cake\Event\EventManagerInterface

pluginBootstrap() ¶ public

pluginBootstrap(): void

Run bootstrap logic for loaded plugins.

Returns
void

pluginConsole() ¶ public

pluginConsole(Cake\Console\CommandCollection $commands): Cake\Console\CommandCollection

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): Cake\Http\MiddlewareQueue

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): Cake\Routing\RouteBuilder

Run routes hooks for loaded plugins

Parameters
Cake\Routing\RouteBuilder $routes

The route builder to use.

Returns
Cake\Routing\RouteBuilder

setEventManager() ¶ public

setEventManager(Cake\Event\EventManagerInterface $eventManager): $this

Sets 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
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs