https://github.com/middlewares/aura-router
PSR-15 middleware to use Aura.Router
https://github.com/middlewares/aura-router
aura http middleware psr-15 router
Last synced: 3 months ago
JSON representation
PSR-15 middleware to use Aura.Router
- Host: GitHub
- URL: https://github.com/middlewares/aura-router
- Owner: middlewares
- License: mit
- Created: 2016-10-02T08:11:19.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-03-26T14:46:30.000Z (about 1 year ago)
- Last Synced: 2025-04-29T09:52:15.866Z (12 months ago)
- Topics: aura, http, middleware, psr-15, router
- Language: PHP
- Homepage:
- Size: 57.6 KB
- Stars: 9
- Watchers: 1
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-psr15-middlewares - middlewares/aura-router - Use [Aura.Router](https://github.com/auraphp/Aura.Router/). (Packages / Router)
README
# middlewares/aura-router
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]](LICENSE)
![Testing][ico-ga]
[![Total Downloads][ico-downloads]][link-downloads]
Middleware to use [Aura.Router](https://github.com/auraphp/Aura.Router/) with a few more extras.
## Requirements
* PHP >= 7.2
* A [PSR-7 http library](https://github.com/middlewares/awesome-psr15-middlewares#psr-7-implementations)
* A [PSR-15 middleware dispatcher](https://github.com/middlewares/awesome-psr15-middlewares#dispatcher)
## Installation
This package is installable and autoloadable via Composer as [middlewares/aura-router](https://packagist.org/packages/middlewares/aura-router).
```sh
composer require middlewares/aura-router
```
## Example
In this example, we are using [middleware/request-handler](https://github.com/middlewares/request-handler) to execute the route handler:
```php
// Create the router
$router = new Aura\Router\RouterContainer();
$map = $router->getMap();
$map->get('hello', '/hello/{name}', function ($request) {
// The route parameters are mapped to attributes
$name = $request->getAttribute('name');
// You can echo the output (it will be captured and wrote into the body)
echo sprintf('Hello %s', $name);
// Or return a string
return sprintf('Hello %s', $name);
// Or return a response
return new Response();
});
$dispatcher = new Dispatcher([
new Middlewares\AuraRouter($router),
new Middlewares\RequestHandler()
]);
$response = $dispatcher->dispatch(new ServerRequest('/hello/world'));
```
**Aura.Router** allows to define anything as the router handler (a closure, callback, action object, controller class, etc.). The middleware will store this handler in a request attribute.
## Usage
Create the middleware with a `Aura\Router\RouterContainer` instance:
```php
$routerContainer = new Aura\Router\RouterContainer();
$route = new Middlewares\AuraRouter($routerContainer);
```
Optionally, you can provide a `Psr\Http\Message\ResponseFactoryInterface` as the second argument, that will be used to create the error responses (`404`, `405` or `406`). If it's not defined, [Middleware\Utils\Factory](https://github.com/middlewares/utils#factory) will be used to detect it automatically.
```php
$routerContainer = new Aura\Router\RouterContainer();
$map = $router->getMap();
$map->get('list', '/users', 'listUsers')->extras(
'key' => 'value'
]);
$optionalResponseFactory = new MyOwnResponseFactory();
$middleware = new Middlewares\AuraRouter($routerContainer, $optionalResponseFactory);
$dispatcher = new Dispatcher([
// Hold the resolved route handler reference in an attribute called "handler"
// (default: request-handler)
$middleware->handlerAttribute('handler'),
// Hold Aura's resolved route instance in an attribute called "aura-route"
// (default: route)
$middleware->routeAttribute('aura-route'),
// Execute the route handler
(new Middlewares\RequestHandler())->handlerAttribute('handler')
]);
// then, inside our Request Handler or Middleware
public function process(
ServerRequestInterface $request,
RequestHandlerInterface $handler
): ResponseInterface {
/** @var string $handler this returns 'listUsers' */
$handler = $request->getAttribute('handler');
/** @var Route $route this returns the resolved Route instance */
$route = $request->getAttribute('aura-route');
// example to retrieve the previously set extra key/value "value"
$route->extras['key'];
// example to retrieve the route name "list"
$route->name;
}
```
---
Please see [CHANGELOG](CHANGELOG.md) for more information about recent changes and [CONTRIBUTING](CONTRIBUTING.md) for contributing details.
The MIT License (MIT). Please see [LICENSE](LICENSE) for more information.
[ico-version]: https://img.shields.io/packagist/v/middlewares/aura-router.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-ga]: https://github.com/middlewares/aura-router/workflows/testing/badge.svg
[ico-downloads]: https://img.shields.io/packagist/dt/middlewares/aura-router.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/middlewares/aura-router
[link-downloads]: https://packagist.org/packages/middlewares/aura-router