Class BaseApplication
Base class for application classes.
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.
Property Summary
-
$configDir protected
string
Method Summary
-
__construct() public
Constructor
-
__invoke() public
Invoke the application.
-
bootstrap() public
Load all the application configuration and bootstrap logic.
-
console() public
Define the console commands for an application.
-
getDispatcher() protected
Get the ActionDispatcher.
-
middleware() abstract public
Define the HTTP middleware layers for an application.
-
routes() public
Define the routes for an application.
Method Detail
__construct() ¶ public
__construct(string $configDir)Constructor
Parameters
-
string$configDir The directory the bootstrap configuration is held in.
__invoke() ¶ public
__invoke(Psr\Http\Message\ServerRequestInterface $request, Psr\Http\Message\ResponseInterface $response, callable $next): Psr\Http\Message\ResponseInterfaceInvoke the application.
- Convert the PSR response into CakePHP equivalents.
- Create the controller that will handle this request.
- Invoke the controller.
Parameters
-
Psr\Http\Message\ServerRequestInterface$request The request
-
Psr\Http\Message\ResponseInterface$response The response
-
callable$next The next middleware
Returns
Psr\Http\Message\ResponseInterfacebootstrap() ¶ public
bootstrap(): voidLoad all the application configuration and bootstrap logic.
Override this method to add additional bootstrap logic for your application.
Returns
voidconsole() ¶ public
console(Cake\Console\CommandCollection $commands): Cake\Console\CommandCollectionDefine the console commands for an application.
By default all commands in CakePHP, plugins and the application will be loaded using conventions based names.
Parameters
-
Cake\Console\CommandCollection$commands The CommandCollection to add commands into.
Returns
Cake\Console\CommandCollectiongetDispatcher() ¶ protected
getDispatcher(): Cake\Http\ActionDispatcherGet the ActionDispatcher.
Returns
Cake\Http\ActionDispatchermiddleware() ¶ abstract public
middleware(Cake\Http\MiddlewareQueue $middleware): Cake\Http\MiddlewareQueueDefine the HTTP middleware layers for an application.
Parameters
-
Cake\Http\MiddlewareQueue$middleware The middleware queue to set in your App Class
Returns
Cake\Http\MiddlewareQueueroutes() ¶ public
routes(Cake\Routing\RouteBuilder $routes): voidDefine the routes for an application.
By default this will load config/routes.php for ease of use and backwards compatibility.
Parameters
-
Cake\Routing\RouteBuilder$routes A route builder to add routes into.
Returns
void