W3cubDocs

/CakePHP 3.6

Class RoutingMiddleware

Applies routing rules to the request and creates the controller instance if possible.

Constants summary

Properties summary

  • $app protected
    The application that will have its routing hook invoked.
  • $cacheConfig protected
    string

    The cache configuration name to use for route collection caching, null to disable caching

Method Summary

  • __construct() public
    Constructor
  • __invoke() public
    Apply routing and update the request.
  • Check if route cache is enabled and use the configured Cache to 'remember' the route collection
  • loadRoutes() protected

    Trigger the application's routes() hook if the application exists and Router isn't initialized. Uses the routes cache if enabled via configuration param "Router.cache"

  • Generate the route collection using the builder

Method Detail

__construct()source public

__construct( Cake\Http\BaseApplication $app null , string|null $cacheConfig null )

Constructor

Parameters

Cake\Http\BaseApplication $app optional null
The application instance that routes are defined on.
string|null $cacheConfig optional null
The cache config name to use or null to disable routes cache

__invoke()source public

__invoke( Psr\Http\Message\ServerRequestInterface $request , Psr\Http\Message\ResponseInterface $response , callable $next )

Apply routing and update the request.

Any route/path specific middleware will be wrapped around $next and then the new middleware stack will be invoked.

Parameters

Psr\Http\Message\ServerRequestInterface $request
The request.
Psr\Http\Message\ResponseInterface $response
The response.
callable $next
The next middleware to call.

Returns

Psr\Http\Message\ResponseInterface
A response.

Throws

Cake\Routing\InvalidArgumentException

buildRouteCollection()source protected

buildRouteCollection( )

Check if route cache is enabled and use the configured Cache to 'remember' the route collection

Returns

Cake\Routing\RouteCollection

loadRoutes()source protected

loadRoutes( )

Trigger the application's routes() hook if the application exists and Router isn't initialized. Uses the routes cache if enabled via configuration param "Router.cache"

If the middleware is created without an Application, routes will be loaded via the automatic route loading that pre-dates the routes() hook.

prepareRouteCollection()source protected

prepareRouteCollection( )

Generate the route collection using the builder

Returns

Cake\Routing\RouteCollection

Properties detail

$appsource

protected Cake\Http\BaseApplication

The application that will have its routing hook invoked.

$cacheConfigsource

protected string

The cache configuration name to use for route collection caching, null to disable caching

© 2005–2018 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.Routing.Middleware.RoutingMiddleware.html