0 follower

Final Class Yiisoft\DataResponse\Middleware\DataResponseMiddleware

All Classes | Methods
InheritanceYiisoft\DataResponse\Middleware\DataResponseMiddleware » Yiisoft\DataResponse\Middleware\AbstractDataResponseMiddleware
ImplementsPsr\Http\Server\MiddlewareInterface

Middleware that applies a custom formatter to Yiisoft\DataResponse\DataStream\DataStream responses and sets appropriate response headers.

Public Methods

Hide inherited methods

Method Description Defined By
__construct() Yiisoft\DataResponse\Middleware\AbstractDataResponseMiddleware
process() Yiisoft\DataResponse\Middleware\AbstractDataResponseMiddleware

Method Details

Hide inherited methods

__construct() public method

Defined in: Yiisoft\DataResponse\Middleware\AbstractDataResponseMiddleware::__construct()

public __construct( Yiisoft\DataResponse\Formatter\FormatterInterface $formatter ): mixed
$formatter Yiisoft\DataResponse\Formatter\FormatterInterface

The formatter to apply to the response.

 

                public function __construct(
    private readonly FormatterInterface $formatter,
) {}
process() public method

Defined in: Yiisoft\DataResponse\Middleware\AbstractDataResponseMiddleware::process()

public process( \Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Server\RequestHandlerInterface $handler ): \Psr\Http\Message\ResponseInterface
$request \Psr\Http\Message\ServerRequestInterface
$handler \Psr\Http\Server\RequestHandlerInterface 

                final public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
{
    $response = $handler->handle($request);
    $body = $response->getBody();
    if (!$body instanceof DataStream || $body->hasFormatter()) {
        return $response;
    }
    $body->changeFormatter($this->formatter);
    return $this->formatter->formatResponse($response);
}