northwoods/conditional-middleware

Middleware proxy for request condition checks

1.0.0 2018-10-17 14:24 UTC

Requires

• php: ^7.1
• psr/http-server-middleware: ^1.0

Requires (Dev)

• nyholm/psr7: ^1.0
• phpstan/phpstan: ^0.10.3
• phpstan/phpstan-phpunit: ^0.10.0
• phpunit/phpunit: ^7.3
• squizlabs/php_codesniffer: ^3.3

MIT

• Woody Gilk

• http
• proxy
• middleware
• wrapper
• request
• conditions
• conditional
• psr-15

README

Middleware proxy that executes a middleware based on request conditions.

Installation

The best way to install and use this package is with composer:

composer require northwoods/conditional-middleware

Usage

use Northwoods\Middleware\ConditionalMiddleware;

/** @var \Psr\Http\Server\MiddlewareInterface */
$actual = /* any existing middleware */

$middleware = new ConditionalMiddleware($actual, function (Request $request): bool {
    return $request->getHeaderLine('accept') === 'application/json';
});

In this example, the wrapped $actual middleware will only be executed if the request accepts the application/json content type.

Condition Callable

The condition callable should use the following signature:

function (Request $request): bool;

The condition must return true (by strict === comparison) for the wrapped middleware to be executed. If the condition check fails the handler will be called immediately.