cormy/onion

Onion style PSR-7 middleware stack using generators

0.2.0 2016-12-04 10:08 UTC

Requires

• php: >=7
• cormy/server-middleware: ^0.1.0
• cormy/server-request-handler: ^0.1.0
• psr/http-message: ^1.0

Requires (Dev)

• sugared-rim/phpunit: ^2.0
• vladahejda/phpunit-assert-exception: ^1.0
• zendframework/zend-diactoros: ^1.3

MIT

• Michael Mayer

• http
• response
• middleware
• request
• stack
• psr
• psr-7
• http-message
• onion
• cormy

README

🌷 Onion style PSR-7 middleware stack using generators

Install

composer require cormy/onion

Usage

use Cormy\Server\Onion;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;

// create the core of the onion, i.e. the innermost request handler
$core = function (ServerRequestInterface $request):ResponseInterface {
    return new \Zend\Diactoros\Response();
};

// create some scales (aka middlewares) to wrap around the core
$scales = [];

$scales[] = function (ServerRequestInterface $request):\Generator {
    // delegate $request to the next request handler, i.e. $core
    $response = (yield $request);

    return $response->withHeader('content-type', 'application/json; charset=utf-8');
};

$scales[] = function (ServerRequestInterface $request):\Generator {
    // delegate $request to the next request handler, i.e. the middleware right above
    $response = (yield $request);

    return $response->withHeader('X-PoweredBy', 'Unicorns');
};

// create an onion style middleware stack
$middlewareStack = new Onion($core, ...$scales);

// and process an incoming server request
$response = $middlewareStack(new \Zend\Diactoros\ServerRequest());

API

Cormy\Server\Onion implements RequestHandlerInterface

Onion::__construct

/**
 * Constructs an onion style PSR-7 middleware stack.
 *
 * @param RequestHandlerInterface|callable                         $core   the innermost request handler
 * @param (MiddlewareInterface|RequestHandlerInterface|callable)[] $scales the middlewares to wrap around the core
 */
public function __construct(callable $core, callable ...$scales)

Inherited from RequestHandlerInterface::__invoke

/**
 * Process an incoming server request and return the response.
 *
 * @param ServerRequestInterface $request
 *
 * @return ResponseInterface
 */
public function __invoke(ServerRequestInterface $request):ResponseInterface

Related

• Cormy\Server\Bamboo – Bamboo style PSR-7 middleware pipe using generators
• Cormy\Server\MiddlewareDispatcher – Cormy PSR-7 server middleware dispatcher
• Cormy\Server\RequestHandlerInterface – Common interfaces for PSR-7 server request handlers
• Cormy\Server\MiddlewareInterface – Common interfaces for Cormy PSR-7 server middlewares

License

MIT © Michael Mayer