ajgarlag/psr15-router

Component to route PSR-7 requests through PSR-15 middlewares

0.5.3 2023-08-24 11:27 UTC

Requires

• php: >=8.0
• psr/container: ^1.1|^2
• psr/http-message: ^1.0|^2
• psr/http-server-middleware: ^1.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.23
• nyholm/psr7: ^1.8
• phpspec/phpspec: ^7.4
• phpstan/extension-installer: ^1.3
• phpstan/phpstan: ^1.10
• phpstan/phpstan-deprecation-rules: ^1.1

MIT

• Antonio J. García Lagar

README

The Psr15 Router component allows you to route PSR-7 requests through PSR-15 middlewares.

Installation

To install the latest stable version of this component, open a console and execute the following command:

$ composer require ajgarlag/psr15-router

Usage

You can choose if you want to route your request through a MiddlewareInterface or a RequestHandlerInterface

Middleware routing

With this option, you has to build a Router to discriminate which middleware will process the request. Then build RouterMiddleware to process the request:

use Ajgarlag\Psr15\Router\Matcher\UriRegexRequestMatcher;
use Ajgarlag\Psr15\Router\Middleware\Route;
use Ajgarlag\Psr15\Router\Middleware\ArrayRouter;
use Ajgarlag\Psr15\Router\Middleware\RouterMiddleware;

$userMiddleware; //Some middleware to process user requests
$userRoute = new Route(
    new UriRegexRequestMatcher('^http(s)?://example.org/user/'),
    $userMiddleware
);
$adminMiddleware; //Some middleware to process admin requests
$adminRoute = new Route(
    new UriRegexRequestMatcher('^http(s)?://example.org/admin/'),
    $adminMiddleware
);

$router = new ArrayRouter();
$router->addRoute($userRoute);
$router->addRoute($adminRoute);

$routerMiddleware = new RouterMiddleware($router);

$response = $routerMiddleware->process($request, $requestHandler);

If the router does not return any middleware to process the request, it is processed directly through the request handler.

Request handler routing

With this option, you has to build a Router to discriminate which request handler will process the request. Then build RouterRequestHandler to process the request. A failover request handler is required to process the request if the router cannot route the request. Usually this failover request handler should return a 404 response.

use Ajgarlag\Psr15\Router\Matcher\UriRegexRequestMatcher;
use Ajgarlag\Psr15\Router\RequestHandler\Route;
use Ajgarlag\Psr15\Router\RequestHandler\ArrayRouter;
use Ajgarlag\Psr15\Router\RequestHandler\RouterRequestHandler;

$userRequestHandler; //Some request handler to process user requests
$userRoute = new Route(
    new UriRegexRequestMatcher('^http(s)?://example.org/user/'),
    $userRequestHandler
);
$adminRequestHandler; //Some request handler to process admin requests
$adminRoute = new Route(
    new UriRegexRequestMatcher('^http(s)?://example.org/admin/'),
    $adminRequestHandler
);

$router = new ArrayRouter();
$router->addRoute($userRoute);
$router->addRoute($adminRoute);

$failoverRequestHandler; // Request handler that returns 404 unconditionally
$routerRequestHandler = new RouterRequestHandler($router, $failoverRequestHandler);

$response = $routerRequestHandler->handle($request);

License

This component is under the MIT license. See the complete license in the LICENSE file.

Reporting an issue or a feature request

Issues and feature requests are tracked in the Github issue tracker.

Author Information

Developed with ♥ by Antonio J. García Lagar.

If you find this component useful, please add a ★ in the GitHub repository page and/or the Packagist package page.