Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/corviz/router
Routing system based on regular expressions for PHP 8.1+ with native Middleware support
https://github.com/corviz/router
middleware php-library php8 router routing
Last synced: about 2 months ago
JSON representation
Routing system based on regular expressions for PHP 8.1+ with native Middleware support
- Host: GitHub
- URL: https://github.com/corviz/router
- Owner: Corviz
- License: mit
- Created: 2023-01-17T18:57:00.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-01-27T14:09:05.000Z (almost 2 years ago)
- Last Synced: 2024-10-28T22:03:46.973Z (about 2 months ago)
- Topics: middleware, php-library, php8, router, routing
- Language: PHP
- Homepage:
- Size: 18.6 KB
- Stars: 5
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Router
Routing system based on regular expressions for PHP 8.1+ with native Middleware support
---
## How to install
```
composer install corviz/router
```
---
## Router facade (singleton)
This is the most common use scenario. That is why we provide a ready-to-use facade.
First, you have to declare you application routes:
```php
use Corviz\Router\Facade\RouterFacade as Router;
/*
* Application routes
*/
Router::get('/', function() {
return 'Hello world!';
});
Route::get('/user/(\d+)', function(int $id){
return "Show information for user $id";
});
```
Then, execute and output the results.
```php
echo Router::dispatch();
!Router::found() && http_response_code(404);
```
**Note:** _Router::dispatch()_ returns the value that was returned by controllers (a string in this example).
### Controller classes
If you use classes as controllers, use an array as the second parameter in the route declaration.
Example controller class
```php
namespace MyApplication;
class UserController
{
public function show(int $id)
{
//Search for user information in the database
//...
return $user;
}
}
```
Route for the controller above.
```php
Router::get('/user/(\d+)', [\MyApplication\User::class, 'show']);
```
## Supported methods
The supported methods for route declarations are: `get`,`post`,`put`,`patch`,`delete`,`options`,`head` or `any`
Each represents one HTTP method, except for `any`, which will attend to all of them
```php
use Corviz\Router\Facade\RouterFacade as Router;
Router::get('/user/(\d+)', function(int $id) { /*...*/ });
Router::post('/user/new', function() { /*...*/ });
Router::delete('/user/(\d+)', function(int $id) { /*...*/ });
```
## Middlewares
Middlewares are responsible for request pre and post processing.
We will accept callables or classes that extends `Corviz\Router\Middleware` as middlewares for your application
```php
use Corviz\Router\Middleware;
class AcceptJsonMiddleware extends Middleware
{
public function handle(Closure $next): mixed
{
//Interrupts in case wrong content-type was sent
if (!$_SERVER['CONTENT_TYPE'] != 'application/json') {
return 'Invalid content type';
}
return $next(); //Proceed with the request
}
}
```
To assign a Middleware do as follows:
```php
use Corviz\Router\Facade\RouterFacade as Router;
Router::any( /*...*/ )
->middleware(AcceptJsonMiddleware::class);
```
Or if you want to assign multiple middlewares at once:
```php
use Corviz\Router\Facade\RouterFacade as Router;
Router::any( /*...*/ )
->middleware([Middleware1::class, Middleware2::class]);
```
## Grouping
To group multiple routes, you must first use the `prefix` method, then just use `group` with a callable
carrying those sub-routes. For example:
```php
use Corviz\Router\Facade\RouterFacade as Router;
Router::prefix('user')->group(function() {
Router::get('list', function() { /**/ });
Router::get('(\d+)', function(int $id) { /**/ });
Router::post('new', function() { /**/ });
Router::patch('(\d+)/update', function(int $id) { /**/ });
Router::delete('(\d+)/delete', function(int $id) { /**/ });
});
```
This will create the following routes:
* user/list
* user/(\d+)
* user/new
* user/(\d+)/update
* user/(\d+)/delete
### Middleware for groups
You can assign middlewares for multiple routes at once by using the `middleware` method between `prefix` and `group`
```php
use Corviz\Router\Facade\RouterFacade as Router;
Router::prefix('api')
->middleware(CheckTokenMiddleware::class)
->middleware(AcceptJsonMiddleware::class)
->group(function() { /* ... */ });
```
## Determine the current path and method manually
The 'dispatch()' method reads 'REQUEST_METHOD' and 'REQUEST_URI' indexes from *$_SERVER* superglobal to determine which
route will be executed.
However, you may want to inform it manually. If so, just feed it as follows:
```php
$method = 'GET'; //or POST, PUT, PATCH, DELETE...
$path = 'users/1/show';
$output = Router::dispatch($method, $path);
```
## Multiple routers
If you have to work with multiple routers for whatever reason, all you have to do is the class Dispatcher,
instead of the router facade
```php
use Corviz\Router\Dispatcher;
$router = new Dispatcher();
$router2 = new Dispatcher();
$router3 = new Dispatcher();
//so on...
```
Then, register and execute the routes as usual:
```php
$router1->get('route1', /* ... */);
$router1->prefix('group1')->group(function() use (&$router1){
$router1->get('route2', /* ... */);
$router1->get('route3', /* ... */);
});
echo $router1->dispatch();
!$router1->found() && http_response_code(404);
```