kovagoz/http-middleware-request-forwarder

An internal redirect mechanism for PSR-15 middleware stacks

dev-master 2022-07-28 07:21 UTC

Requires

• php: ^8.0
• psr/http-server-middleware: ^1.0.0

Requires (Dev)

• nyholm/psr7: ^1.4.1
• phpunit/phpunit: ^9.4.0
• roave/security-advisories: dev-latest

Suggests

• kovagoz/http-responder: ^1.0.0

MIT

• Zoltan Kovago

README

The aim of this library is to make it possible to pass the HTTP request to another handler, creating a so-called internal redirect.

Requirements

• PHP >= 8.0

Usage

Put this middleware into the stack before any request handler. If you want to pass the request to another handler, then return a response from the current handler with the X-Internal-Redirect header, and its value should be the name of the target handler.

If you are using PSR-17 factories, the code will look like this:

<?php

class SomeHandler implements RequestHandlerInterface
{
    public function handle(ServerRequestInterface $request)
    {
        return $this->responseFactory
            ->createResponse()
            ->withHeader('X-Internal-Redirect', AnotherHandler::class);
    }
}

If you are utilizing the kovagoz/http-responder library, then the HttpResponder extension found in this package can simplify the forward process for you.

<?php

// Extend the HttpResponder...
$responder = new class($responseFactory, $streamFactory) extends HttpResponder {
    use ResponseHelper;
};

// ...then call forward() in your handler.
return $responder->forward(AnotherHandler::class);