Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ajgarlag/psr15-router
Component to route PSR-7 requests through PSR-15 middlewares
https://github.com/ajgarlag/psr15-router
Last synced: 19 days ago
JSON representation
Component to route PSR-7 requests through PSR-15 middlewares
- Host: GitHub
- URL: https://github.com/ajgarlag/psr15-router
- Owner: ajgarlag
- License: mit
- Created: 2017-07-14T08:21:01.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-08-24T11:29:28.000Z (about 1 year ago)
- Last Synced: 2024-10-11T13:12:18.007Z (about 1 month ago)
- Language: PHP
- Size: 49.8 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Psr15 Router
============
The Psr15 Router component allows you to route [PSR-7] requests through [PSR-15] middlewares.
[](https://github.com/ajgarlag/psr15-router/actions/workflows/tests.yaml)
[](https://packagist.org/packages/ajgarlag/psr15-router)
[](https://packagist.org/packages/ajgarlag/psr15-router)
[](https://packagist.org/packages/ajgarlag/psr15-router)
[](https://packagist.org/packages/ajgarlag/psr15-router)
[](https://packagist.org/packages/ajgarlag/psr15-router)
[](https://packagist.org/ajgarlag/psr15-router)
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:
```php
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.
```php
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].
[PSR-7]: http://www.php-fig.org/psr/psr-7/
[PSR-15]: https://www.php-fig.org/psr/psr-15/
[MiddlewareInterface]: https://www.php-fig.org/psr/psr-15/#22-psrhttpservermiddlewareinterface
[RequestHandlerInterface]: https://www.php-fig.org/psr/psr-15/#21-psrhttpserverrequesthandlerinterface
[LICENSE]: LICENSE
[Github issue tracker]: https://github.com/ajgarlag/psr15-router/issues
[Antonio J. García Lagar]: http://aj.garcialagar.es
[GitHub repository page]: https://github.com/ajgarlag/psr15-router
[Packagist package page]: https://packagist.org/packages/ajgarlag/psr15-router