0

Abstract Class Yiisoft\DataResponse\Middleware\AbstractDataResponseMiddleware

All Classes | Methods
InheritanceYiisoft\DataResponse\Middleware\AbstractDataResponseMiddleware
ImplementsPsr\Http\Server\MiddlewareInterface
SubclassesYiisoft\DataResponse\Middleware\DataResponseMiddleware, Yiisoft\DataResponse\Middleware\HtmlDataResponseMiddleware, Yiisoft\DataResponse\Middleware\JsonDataResponseMiddleware, Yiisoft\DataResponse\Middleware\PlainTextDataResponseMiddleware, Yiisoft\DataResponse\Middleware\XmlDataResponseMiddleware

Abstract middleware class that applies a formatter to {@see DataStream} responses and sets appropriate response headers.

The middleware only formats responses whose body is a {@see \Yiisoft\DataResponse\DataStream\DataStream} without a formatter set.

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

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

The formatter to apply to the response.

 

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

public \Psr\Http\Message\ResponseInterface process ( \Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Server\RequestHandlerInterface $handler )
$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);
}