pavlakis/php-server-interface-middleware

Middleware to filter based on server type interface e.g. PHP SAPI

0.2 2018-10-28 21:55 UTC

This package is auto-updated.

Last update: 2024-10-15 02:29:12 UTC


README

Build Status Total Downloads Latest Stable Version codecov PHPStan

Server Interface (SAPI) Middleware

Middleware to filter based on server type interface e.g. PHP SAPI

Add it with composer

composer require pavlakis/php-server-interface-middleware

Pass it to a route

Use by adding it to a route. e.g. in Slim 3:

$app->get('/status', 'PHPMinds\Action\EventStatusAction:dispatch')
    ->add(new Pavlakis\Middleware\Server\Sapi(["cli"]))

We can pass an array of accepted interfaces. If those are not matched, a default response with a 403 status code will be returned.

Pass a custom response

For a custom response pass a Response object. e.g.

        $whiteList = ["cli"];
        $sapiRes = new Response();
        $sapiRes = $sapiRes->withStatus(500);

        $sapi = new Sapi($whiteList, $sapiRes);