Base class for full-stack applications
This class serves as a base class for applications that are using CakePHP as a full stack framework. If you are only using the Http or Console libraries you should implement the relevant interfaces directly.
The application class is responsible for bootstrapping the application, and ensuring that middleware is attached. It is also invoked as the last piece of middleware, and delegates request/response handling to the correct controller.
stringDefault class name for new event objects.
\Cake\Event\EventManagerInterfaceInstance of the Cake\Event\EventManager this object is using to dispatch inner events.
string\Cake\Http\ControllerFactoryInterface|nullController factory
\Cake\Core\PluginCollectionPlugin Collection
__construct(string $configDir, ?\Cake\Event\EventManagerInterface $eventManager, ?\Cake\Http\ControllerFactoryInterface $controllerFactory)
Constructor
string $configDir The directory the bootstrap configuration is held in.
\Cake\Event\EventManagerInterface $eventManager optional Application event manager instance.
\Cake\Http\ControllerFactoryInterface $controllerFactory optional Controller factory.
addOptionalPlugin(mixed $name, array $config)
Add an optional plugin
If it isn't available, ignore it.
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
$thisaddPlugin(mixed $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.
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
$thisbootstrap()
Load all the application configuration and bootstrap logic.
Override this method to add additional bootstrap logic for your application.
console(\Cake\Console\CommandCollection $commands)
Define the console commands for an application.
By default all commands in CakePHP, plugins and the application will be loaded using conventions based names.
\Cake\Console\CommandCollection $commands The CommandCollection to add commands into.
\Cake\Console\CommandCollectionThe updated collection.
dispatchEvent(string $name, ?array $data, ?object $subject)
Wrapper for creating and dispatching events.
Returns a dispatched event.
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).
\Cake\Event\EventInterfacegetEventManager()
Returns 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.
\Cake\Event\EventManagerInterfacegetPlugins()
Get the plugin collection in use.
\Cake\Core\PluginCollectionhandle(\Psr\Http\Message\ServerRequestInterface $request)
Invoke the application.
\Psr\Http\Message\ServerRequestInterface $request The request
\Psr\Http\Message\ResponseInterfacemiddleware(\Cake\Http\MiddlewareQueue $middlewareQueue)
\Cake\Http\MiddlewareQueue $middlewareQueue The middleware queue to set in your App Class
\Cake\Http\MiddlewareQueuepluginBootstrap()
Run bootstrap logic for loaded plugins.
pluginConsole(\Cake\Console\CommandCollection $commands)
Run console hooks for plugins
\Cake\Console\CommandCollection $commands The CommandCollection to use.
\Cake\Console\CommandCollectionpluginMiddleware(\Cake\Http\MiddlewareQueue $middleware)
Run middleware hooks for plugins
\Cake\Http\MiddlewareQueue $middleware The MiddlewareQueue to use.
\Cake\Http\MiddlewareQueuepluginRoutes(\Cake\Routing\RouteBuilder $routes)
Run routes hooks for loaded plugins
\Cake\Routing\RouteBuilder $routes The route builder to use.
\Cake\Routing\RouteBuilderroutes(\Cake\Routing\RouteBuilder $routes)
Define the routes for an application.
Use the provided RouteBuilder to define an application's routing.
\Cake\Routing\RouteBuilder $routes A route builder to add routes into.
setEventManager(\Cake\Event\EventManagerInterface $eventManager)
Returns the Cake\Event\EventManagerInterface 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.
\Cake\Event\EventManagerInterface $eventManager the eventManager to set
$thisDefault class name for new event objects.
stringInstance of the Cake\Event\EventManager this object is using to dispatch inner events.
\Cake\Event\EventManagerInterfacestringController factory
\Cake\Http\ControllerFactoryInterface|nullPlugin Collection
\Cake\Core\PluginCollection
© 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/4.1/class-Cake.Http.BaseApplication.html