mizmoz/router

Mizmoz Router

1.0.0 2024-09-27 03:05 UTC

Requires

• php: >=8.3
• guzzlehttp/psr7: ^2.7
• psr/container: ^2.0
• psr/http-message: ^2.0

Requires (Dev)

• mizmoz/container: ^2.0
• phpstan/phpstan: ^1.12
• phpunit/phpunit: ^11.0

MIT

• Ian Chadwick

README

A Simple Router for HTTP

Aims

• Be lightweight
• Use PSR-7 HTTP message interfaces
• Use PSR-15 HTTP server middleware (when it becomes standardised, maybe, it's a mess right now)
• Resolution with PSR-11: Container interface

Basic Usage

// create a simple route
$route = Route::get('/', function (RequestInterface $request, ResponseInterface $response, ResultInterface $result) {
  return $response;
});

// init with a PSR-11 compatible container for class resolution
$dispatcher = new Router($route, $container);

// dispatch the route by passing a PSR-7 compatible Request
$response = $dispatcher->dispatch(new ServerRequest('GET', '/'));

exit($response->getBody()->getContents());

More examples

// class callback which will call the default process($request, $response, $next);
Route::get('/admin', AdminController::class);

// class callback with specific method
Route::get('/admin', [AdminController::class, 'home']);

// Route to app\actions\User\GetProfile.php
Route::get('/profile/{:userId}', 'User\GetProfile');

// A more complete route
Route::get('/', HomePage::class, function (RouteInterface $r) {
    // add some child routes
    $r->addRoute('GET', '/profile', ...);
});

// wildcard matching
Route::get('/app/*', AppController::class);

Routes with variables

// create the route with simple variable matching using :variable format
$route = new Route('GET', '/users/:userId', UserGet::class);

// get the variable
$userId = $route->match('GET', '/users/123')->getVariable('userId');

Get the route result object from the request either in the route endpoint or middleware

public function myMethod(ServerRequestInterface $request, ...)
{
    var_dump($request->getAttribute(Dispatcher::ATTRIBUTE_RESULT_KEY));
}

Middleware

// add global middleware
$router->addMiddleware(new EnsureSsl());

// add middlware to a route, middleware is added before the route definition by default
$router->get('admin', AdminController::class)
    ->addMiddleware(new EnsureSsl());

// add to all routes
$router->get('/', function (RouteInterface $r) {
    $r->get('/users', ...);
})->addMiddleware(new AclUser('admin'));

Roadmap

• Add REST API helper for classes
• Allow fallback / catch all / error routes