Router PSR7 and PSR15.
composer require rancoud/router
Http package: https://github.com/rancoud/Http
// Instantiation
$router = new Router();
// Add routes
$router->get('/posts', function ($request, $next) {
return (new MessageFactory())->createResponse(200, null, [], 'ok');
});
// Find route
$found = $router->findRoute('GET', '/posts');
// You can use PSR-7 request for finding Route
$found = $router->findRouteRequest(new \Rancoud\Http\Message\ServerRequest('GET', '/posts'));
// Dispatch (response is a PSR7 object \Psr\Http\Message\Response)
$response = $router->dispatch($request);
// Display Response
$response->send();
// Methods shortcuts
$router->get('/posts/{id}', function ($request, $next) {});
$router->post('/posts/{id}', function ($request, $next) {});
$router->put('/posts/{id}', function ($request, $next) {});
$router->patch('/posts/{id}', function ($request, $next) {});
$router->delete('/posts/{id}', function ($request, $next) {});
$router->options('/posts/{id}', function ($request, $next) {});
// Any methods
$router->any('/posts/{id}', function ($request, $next) {});
// CRUD method
$router->crud('/posts', function ($request, $next) {});
Use the pattern {name}
for naming your parameters
$router->get('/posts/{id}', function ($request, $next) {});
Use regex syntax for your constraints
// inline for simple case
$router->get('/{id:\d+}', function ($request, $next) {});
// complex
$route = new Route('GET', '/{id}', function ($request, $next) {});
$route->setParametersConstraints(['id' => '\d+']);
You can setup a global constraint when you use the same regex multiple times
$router->setGlobalParametersConstraints(['lang' => 'en|fr']);
// {lang} will use the global constraints
$router->get('/article/{lang}', function ($request, $next) {});
// {lang} will use the local constraints define by the route
$router->get('/news/{lang}', function ($request, $next) {})->setParametersConstraints(['lang' => 'jp']);
You can use on each route an optional parameters.
The parameters {page}
will be replace with the value 1
if it is not present
$route = new Route('GET', '/{id}/{page}', function ($request, $next) {});
$route->setOptionalsParameters(['page' => 1]);
// global middleware for router
$router->addGlobalMiddleware(function ($request, $next) {});
// middleware for only route
$route = new Route('GET', '/{id}', function ($request, $next) {});
$route->addMiddleware(function ($request, $next) {});
// for passing to next middleware
$router->addGlobalMiddleware(function ($request, $next) {
$next($request);
});
// you can add an instance of Router as a middleware
$subRouter1 = new Router();
$subRouter1->any('/api/books/{id}', function ($req, $next){
return (new MessageFactory())->createResponse(200, null, [], 'testRouterception books');
});
$subRouter2 = new Router();
$subRouter2->any('/api/peoples/{id}', function ($req, $next){
return (new MessageFactory())->createResponse(200, null, [], 'testRouterception peoples');
});
$router->addGlobalMiddleware($subRouter1);
$router->addGlobalMiddleware($subRouter2);
// you can add an instance of Router in a Route callback
$subRouter1 = new Router();
$subRouter1->any('/api/books/{id}', function ($req, $next){
return (new MessageFactory())->createResponse(200, null, [], 'testRouterception books');
});
$subRouter2 = new Router();
$subRouter2->any('/api/peoples/{id}', function ($req, $next){
return (new MessageFactory())->createResponse(200, null, [], 'testRouterception peoples');
});
$router->any('/api/books/{id}', $subRouter1);
$router->any('/api/peoples/{id}', $subRouter2);
// you can set a default 404
$router->setDefault404( static function ($request, $next) {
return (new \Rancoud\Http\Message\Factory\Factory())->createResponse(404, '')->withBody(Rancoud\Http\Message\Stream::create('404 content'));
});
// it will return false because no Route is matching
$found = $router->findRoute('GET', '/posts');
// response contains the default 404 callback
$response = $router->dispatch($request);
$response->send();
WARNING with 404 and Router as Middleware
// create new Router with default 404
$subRouter = new Router();
$subRouter->any('/posts/{id:\d+}', function ($req, $next){
return (new MessageFactory())->createResponse(200, null, [], 'read 1 post');
});
$subRouter->setDefault404( static function ($request, $next) {
return (new \Rancoud\Http\Message\Factory\Factory())->createResponse(404, '')->withBody(Rancoud\Http\Message\Stream::create('404 content from subRouter'));
});
// you can add a Router as middleware
$router->any('/posts/{id}', $subRouter);
// it will return true because Router middleware is matching on /posts/{id}
$found = $router->findRoute('GET', '/posts/incorrect');
// response contains the default 404 callback from $subRouter
$response = $router->dispatch($request);
$response->send();
If you use Router as middleware AND set default 404 then findRouteRequest
and findRoute
will return true
.
When calling dispatch
it will use the callback setted as default 404 by the Router middleware.
It will create all this routes: GET $prefixPath GET / POST $prefixPath . '/new' GET / POST / DELETE $prefixPath . '/{id:\d+}'
In this example you can setup router's middlewares and routes with an array
$config = [
'router' => [
'middlewares' => [
'global_callback1',
'global_callback2',
'global_callback3'
],
'constraints' => [
'lang' => 'en|fr'
],
'host' => '{service}.domain.{tld}',
'host_constraint' => [
'service' => 'api|backoffice|www|m',
'tld' => 'en|jp'
],
'default_404' => 'callable_404'
],
'routes' => [
[
'methods' => ['GET'],
'url' => '/articles/{id}',
'callback' => 'route_callback',
'constraints' => ['id' => '\w+'],
'middlewares' => ['route_middleware1', 'route_middleware2'],
'name' => 'route1'
],
[
'methods' => ['POST'],
'url' => '/form',
'callback' => 'callback',
],
[
'methods' => ['POST'],
'url' => '/api/form',
'callback' => 'callback',
'host' => 'api.domain.{tld}',
'host_constraint' => [
'tld' => 'en|jp'
]
],
[
'methods' => ['GET'],
'url' => '/blog/{page}',
'callback' => 'callback',
'optionals_parameters' => [
'page' => '1'
]
]
]
];
$router = new Router();
$router->setupRouterAndRoutesWithConfigArray($config);
// you can add a Router as a callback
$subRoute = new Router();
$subRoute->setupRouterAndRoutesWithConfigArray($config);
$router->any('/(.*)', $subRoute);
The difference between dispatch and handle is dispatch is used in first place. Handle is from the PSR17 in Psr\Http\Message\ServerRequestInterface, it's useful for middleware.
Parameter | Type | Description |
---|---|---|
methods | string | array | methods matching with the route |
url | string | url to match |
callback | string | Closure | \Psr\Http\Server\MiddlewareInterface | \Rancoud\Router\Router | callback when route is calling by router |
composer ci
for php-cs-fixer and phpunit and coverage
composer lint
for php-cs-fixer
composer test
for phpunit and coverage