borschphp / router
A FastRoute router implementation.
Requires
- php: ^8.1
- nikic/fast-route: ^v1.3
- psr/http-message: ^1||^2
- psr/http-server-handler: ^1
- psr/http-server-middleware: ^1
Requires (Dev)
- laminas/laminas-diactoros: ^3
- nikic/php-parser: ^v4.18
- pestphp/pest: ^2.6
This package is auto-updated.
Last update: 2024-10-19 16:03:23 UTC
README
Borsch Router
An awesome FastRoute router implementation based on nikic/fast-route request router.
Table of Contents
About The Project
A FastRoute router implementation, inspired by the one you can find in the excellent Mezzio Routing Interfaces.
The router is based on nikic/fastroute request router.
You need to provide a PSR-7 ServerRequestInterface in order to match the routes.
A PSR-7 ResponseInterface must be returned by the route handler.
Getting Started
Prerequisites
You need PHP >= 8.1
to use Borsch\Router
but the latest stable version of PHP is always recommended.
It also requires an implementation of PSR-7 HTTP Message.
The Laminas Diactoros Project is used for testing, and in the examples below.
Installation
Via composer :
composer require borschphp/router
Usage
require_once __DIR__.'/vendor/autoload.php'; $router = new \Borsch\Router\FastRouteRouter(); $router->addRoute(new \Borsch\Router\Route( ['GET'], '/articles/{id:\d+}[/{slug}]', new ArticleHandler(), // Instance of RequestHandlerInterface 'articles.id.title' )); $server_request = \Laminas\Diactoros\ServerRequestFactory::fromGlobals(); // $route_result is an instance of RouteResultInterface $route_result = $router->match($server_request); // $route is an instance of RouteInterface (or false if no match) $route = $route_result->getMatchedRoute(); if (!$route) { return new \Laminas\Diactoros\Response('Not Found', 404); } // $response is an instance of ResponseInterface $response = $route->getHandler()->handle($server_request); // Send the response back to the client or other...
Testing
This package uses Pest
as test framework.
To run tests :
./vendor/bin/pest tests
Mutation testing has also been used to create this package, with Infection
.
More information on Infection page.
To run mutation tests, install infection
as described in the documentation, then run this command:
XDEBUG_MODE=coverage infection
An text based and HTML report will be generated in the project folder.
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the MIT License. See License File for more information.
Acknowledgments
A big thanks to these projects for inspiration or because they're used in this one: