thecodingmachine/middleware-list-universal-module

Cross-framework module providing a service containing a list of middlewares

v1.1.1 2018-06-05 13:27 UTC

This package is auto-updated.

Last update: 2021-04-06 16:04:10 UTC


README

This package simply providers an http-interop middleware list to any container-interop compatible framework/container. The middleware list is empty. Any package can come and add a middleware to the list.

Installation

This package is typically used by packages providing middlewares.

composer require thecodingmachine/middleware-list-universal-module

If your container supports autodiscovery by thecodingmachine/discovery, there is nothing more to do. Otherwise, you need to register the TheCodingMachine\MiddlewareListServiceProvider into your container.

Refer to your framework or container's documentation to learn how to register service providers.

Usage

The middleware queue is registered under the key MiddlewareListServiceProvider::MIDDLEWARES_QUEUE. This is a \SPLPriorityQueue.

Depending on the middleware you are registering, you generally have a fairly good idea of the order it should run compared to other middlewares.

Let's split the middlewares in 4 families:

  • Utility middlewares: those are typically handled at the beginning of a request. They are used to modify/enrich the response and pass it to other middlewares. In this category, you would put middlewares that compute the response time, middlewares that add geolocation information, middlewares that manage sessions, etc...
  • Routers: those are middlewares that are typically used to handle a request and return a response. They respond on specific routes or pass the request along to the next router if they don't know that route.
  • Page not found routers: those are middlewares in charge of answering a 404 answer if no middleware has handled the request. This is the last "classical" middleware of the queue.
  • Error handling middlewares: Finally, at the very end of the queue, you will find the list of middlewares that handle errors and exceptions. They are in charge of logging or displaying error messages.

Based on those 4 families, the MiddlewareListServiceProvider provides a SPL Priority Queue that one can use to register any middleware at the right point in the queue.

The service provider defines 12 constants you can use to insert a middleware at a given point:

  • MiddlewareOrder::EXCEPTION_EARLY (3050)
  • MiddlewareOrder::EXCEPTION (3000)
  • MiddlewareOrder::EXCEPTION_LATE (2950)
  • MiddlewareOrder::UTILITY_EARLY (2050)
  • MiddlewareOrder::UTILITY (2000)
  • MiddlewareOrder::UTILITY_LATE (1950)
  • MiddlewareOrder::ROUTER_EARLY (1050)
  • MiddlewareOrder::ROUTER (1000)
  • MiddlewareOrder::ROUTER_LATE (950)
  • MiddlewareOrder::PAGE_NOT_FOUND_EARLY (50)
  • MiddlewareOrder::PAGE_NOT_FOUND (0)
  • MiddlewareOrder::PAGE_NOT_FOUND_LATE (-50)

Each "family" has 3 variants: EARLY, NORMAL and LATE, so you can add more fine grained tuning if you want a utility to be triggered before another one, etc...

So if you want to register a middleware, you would typically write:

$middlewareQueue = $container->get(MiddlewareListServiceProvider::MIDDLEWARES_QUEUE);
/* @var $middlewareQueue \SplPriorityQueue */
$middlewareQueue->insert($myMiddleware, MiddlewareOrder::UTILITY);