0 follower

Final Class Yiisoft\DataResponse\ResponseFactory\XmlResponseFactory

All Classes | Methods

Inheritance	Yiisoft\DataResponse\ResponseFactory\XmlResponseFactory » Yiisoft\DataResponse\ResponseFactory\AbstractFormattedResponseFactory
Implements	Yiisoft\DataResponse\ResponseFactory\DataResponseFactoryInterface

Factory that creates responses with XML-formatted Yiisoft\DataResponse\DataStream\DataStream body and appropriate response headers.

Public Methods

Hide inherited methods

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

Method Details

Hide inherited methods

__construct() public method

public __construct( \Psr\Http\Message\ResponseFactoryInterface $responseFactory, Yiisoft\DataResponse\Formatter\XmlFormatter $formatter ): mixed
$responseFactory	\Psr\Http\Message\ResponseFactoryInterface	The PSR-17 response factory.
$formatter	Yiisoft\DataResponse\Formatter\XmlFormatter	The XML formatter to use.

Source code

                public function __construct(
    ResponseFactoryInterface $responseFactory,
    XmlFormatter $formatter,
) {
    parent::__construct($responseFactory, $formatter);
}

createResponse() public method

Defined in: Yiisoft\DataResponse\ResponseFactory\AbstractFormattedResponseFactory::createResponse()

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

Source code

                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);
}