PSR-15 middleware to execute request handlers
Clone or download
Latest commit adcc7dd Oct 26, 2018

README.md

middlewares/request-handler

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

Middleware to execute request handlers discovered by a router.

Requirements

Installation

This package is installable and autoloadable via Composer as middlewares/request-handler.

composer require middlewares/request-handler

You may also want to install any route middleware like middlewares/fast-route or middlewares/aura-router for routing.

Purpose

There are two completely separate steps when it comes to route handling:

  1. Determining if the request is valid and can be resolved by the application.
  2. Handling the request inside the application.

The first step usually resolves into a route callback, while the product of the second one is usually the result of executing that callback.

Multiple things that can happen between the first and second steps: input validation, authentication, authorization, etc. and in some scenarios we may not want to continue processing the request (e.g. auth, accessing DB resources, etc.) if that would ultimately fail to resolve e.g. procuding an HTTP 400 error.

Splitting routing from request handling allows us to use any middleware between these two steps. It also makes the request-handler middleware able to be used with any routing component.

Example

A routing middleware needs to be called before the request can be handled. In this example, we will use fast-route middleware.

// Create the routing dispatcher
$fastRouteDispatcher = FastRoute\simpleDispatcher(function (FastRoute\RouteCollector $r) {
    $r->get('/hello/{name}', HelloWorldController::class);
});

$dispatcher = new Dispatcher([
    new Middlewares\FastRoute($fastRouteDispatcher),
    // ...
    new Middlewares\RequestHandler(),
]);

$response = $dispatcher->dispatch(new ServerRequest('/hello/world'));

When the request handler is invoked, it expects a request attribute to be defined that contains a reference to the handler. The handler must be a string, a callable or an object implementing MiddlewareInterface or RequestHandlerInterface. If it's a string, a ContainerInterface will be used to resolve it and get the MiddlewareInterface or RequestHandlerInterface to use. If it's a callable, it will be converted automatically to MiddlewareInterface using the Middlewares\Utils\CallableHandler

// Use a PSR-11 container to create the intances of the request handlers
$container = new RequestHandlerContainer();

$dispatcher = new Dispatcher([
    // ...
    new Middlewares\RequestHandler($container),
]);

API

__construct

Define the container used to resolve the handlers if they are provided as string (or an array with 2 strings). By default will use Middlewares\Utils\RequestHandlerContainer.

Type Required Description
Psr\Container\ContainerInterface No The custom container instance

handlerAttribute

Configures the attribute name used to get the handler reference in the server request. The default is request-handler.

Type Required Description
string Yes The new attribute name

continueOnEmpty

If the server request attribute is empty or does not exists, an exception is throwed. This function changes this behavior to continue with the next middleware.

Type Required Description
string No Set true to continue, false to throw the exception. If none is defined, true will be used.

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

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