middlewares/aura-router

Middleware to use Aura.Router

v1.1.0 2018-08-04 10:41 UTC

README

Latest Version on Packagist Software License Build Status Quality Score Total Downloads SensioLabs Insight

Middleware to use Aura.Router and store the route handler in a request attribute.

Requirements

Installation

This package is installable and autoloadable via Composer as middlewares/aura-router.

composer require middlewares/aura-router

Example

In this example, we are using middleware/request-handler to execute the route handler:

//Create the router
$router = new Aura\Router\RouterContainer();

$map = $router->getMap();

$map->get('hello', '/hello/{name}', function ($request) {

    //The route parameters are stored as attributes
    $name = $request->getAttribute('name');

    //You can echo the output (it will be captured and writted 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.

Options

__construct(Aura\Router\RouterContainer $router)

The router instance to use.

attribute(string $attribute)

The name of the server request attribute used to save the handler. The default value is request-handler.

responseFactory(Psr\Http\Message\ResponseFactoryInterface $responseFactory)

A PSR-17 factory to create the error responses (404, 405, 406, etc).

Please see CHANGELOG for more information about recent changes and CONTRIBUTING for contributing details.

The MIT License (MIT). Please see LICENSE for more information.