PHP Interface Phly\Conduit\MiddlewareInterface

Middleware accepts a request and a response, and optionally a callback $out (called if the middleware wants to allow further middleware to process the incoming request, or to delegate output to another process). Middleware that does not need or desire further processing should not call $out, and should usually instead return $response->end();. For the purposes of Conduit, $out is typically one of either an instance of Next or an instance of FinalHandler, and, as such, should follow those calling semantics.
Datei anzeigen Open project: phly/conduit

Public Methods

Method Description
__invoke ( Psr\Http\Message\ServerRequestInterface $request, Psr\Http\Message\ResponseInterface $response, callable $out = null ) : null | Psr\Http\Message\ResponseInterface Process an incoming request and/or response.

Method Details

__invoke() public method

Accepts a server-side request and a response instance, and does something with them. If the response is not complete and/or further processing would not interfere with the work done in the middleware, or if the middleware wants to delegate to another process, it can use the $out callable if present. If the middleware does not return a value, execution of the current request is considered complete, and the response instance provided will be considered the response to return. Alternately, the middleware may return a response instance. Often, middleware will return $out();, with the assumption that a later middleware will return a response.
public __invoke ( Psr\Http\Message\ServerRequestInterface $request, Psr\Http\Message\ResponseInterface $response, callable $out = null ) : null | Psr\Http\Message\ResponseInterface
$request Psr\Http\Message\ServerRequestInterface
$response Psr\Http\Message\ResponseInterface
$out callable
return null | Psr\Http\Message\ResponseInterface