A middleware dispatching to other middleware stacks, based on different path prefixes.
- PHP >= 7.2
- A PSR-7 http library
- A PSR-15 middleware dispatcher
This package is installable and autoloadable via Composer as middlewares/base-path-router.
composer require middlewares/base-path-router
You may also want to install middlewares/request-handler.
This example uses middleware/request-handler to execute the route handler:
$dispatcher = new Dispatcher([
new Middlewares\BasePathRouter([
'/admin' => $admin,
'/admin/login' => $adminLogin,
'/blog' => $blog,
]),
new Middlewares\RequestHandler()
]);
$response = $dispatcher->dispatch(new ServerRequest());
BasePathRouter allows anything to be defined as the router handler (a closure, callback, action object, controller class, etc). The middleware will store this handler in a request attribute.
You have to set an array of paths (as keys) and handlers (as values).
$router = new Middlewares\BasePathRouter([
'/foo' => $routerFoo,
'/bar' => $routerBar,
'/foo/bar' => $routerFooBar,
]);
Optionally, you can provide a Psr\Http\Message\ResponseFactoryInterface
as the second argument, to create the error responses (404
) if the router is not found. If it's not defined, Middleware\Utils\Factory will be used to detect it automatically.
$responseFactory = new MyOwnResponseFactory();
$router = new Middlewares\BasePathRouter($paths, $responseFactory);
Set true
to continue to the next middleware instead return an empty 404 response for non-matching requests (i.e. those that do not have an URI path start with one of the provided prefixes).
By default, subsequent middleware will receive a slightly manipulated request object: any matching path prefixes will be stripped from the URI.
This helps when you have a hierarchical setup of routers, where subsequent routers (e.g. one for the API stack mounted under the /api
endpoint) can ignore the common prefix.
If you want to disable this behavior, use the stripPrefix
method:
$router = (new Middlewares\BasePathRouter([
'/prefix1' => $middleware1,
]))->stripPrefix(false);
The attribute name used to store the handler in the server request. The default attribute name is request-handler
.
$dispatcher = new Dispatcher([
//Save the route handler in an attribute called "route"
(new Middlewares\BasePathRouter($paths))->attribute('route'),
//Execute the route handler
(new Middlewares\RequestHandler())->attribute('route')
]);
Please see CHANGELOG for more information about recent changes and CONTRIBUTING for contributing details.
The MIT License (MIT). Please see LICENSE for more information.