0

Abstract Class Yiisoft\DataResponse\ResponseFactory\AbstractFormattedResponseFactory

All Classes | Methods
InheritanceYiisoft\DataResponse\ResponseFactory\AbstractFormattedResponseFactory
ImplementsYiisoft\DataResponse\ResponseFactory\DataResponseFactoryInterface
SubclassesYiisoft\DataResponse\ResponseFactory\FormattedResponseFactory, Yiisoft\DataResponse\ResponseFactory\HtmlResponseFactory, Yiisoft\DataResponse\ResponseFactory\JsonResponseFactory, Yiisoft\DataResponse\ResponseFactory\PlainTextResponseFactory, Yiisoft\DataResponse\ResponseFactory\XmlResponseFactory

Abstract factory class that creates responses with pre-formatted {@see DataStream} body and appropriate response headers.

The formatter is applied immediately when creating the response.

Public Methods

Hide inherited methods

Method Description Defined By
__construct() Yiisoft\DataResponse\ResponseFactory\AbstractFormattedResponseFactory
createResponse() Yiisoft\DataResponse\ResponseFactory\AbstractFormattedResponseFactory

Method Details

Hide inherited methods

__construct() public method

public mixed __construct ( \Psr\Http\Message\ResponseFactoryInterface $responseFactory, Yiisoft\DataResponse\Formatter\FormatterInterface $formatter )
$responseFactory \Psr\Http\Message\ResponseFactoryInterface

The PSR-17 response factory.
$formatter Yiisoft\DataResponse\Formatter\FormatterInterface

The formatter to apply to the response.

 

                public function __construct(
    private readonly ResponseFactoryInterface $responseFactory,
    private readonly FormatterInterface $formatter,
) {}
createResponse() public method

public \Psr\Http\Message\ResponseInterface createResponse ( mixed $data = null, integer $code = Status::OK, string $reasonPhrase = '' )
$data mixed
$code integer
$reasonPhrase string 

                final public function createResponse(
    mixed $data = null,
    int $code = Status::OK,
    string $reasonPhrase = '',
): ResponseInterface {
    $body = new DataStream($data, $this->formatter);
    $response = $this->responseFactory
        ->createResponse($code, $reasonPhrase)
        ->withBody($body);
    return $this->formatter->formatResponse($response);
}