yiisoft / data-response

Yii Data Response

The package allows responding with data that is automatically converted into PSR-7 response.

Requirements

• PHP 8.1 or higher.
• DOM PHP extension.

Installation

The package could be installed with Composer:

composer require yiisoft/data-response

General usage

The package provides DataResponseFactory class that, given a PSR-17 response factory, is able to create data response.

Data response contains raw data to be processed later.

use Yiisoft\DataResponse\DataResponseFactory;

/**
 * @var Psr\Http\Message\ResponseFactoryInterface $responseFactory
 */

$factory = new DataResponseFactory($responseFactory);
$dataResponse = $factory->createResponse('test');
$dataResponse
    ->getBody()
    ->rewind();

echo $dataResponse
    ->getBody()
    ->getContents(); // "test"

Formatters

Formatter purpose is to format a data response. In the following example we format data as JSON.

use Yiisoft\DataResponse\DataResponseFactory;
use Yiisoft\DataResponse\Formatter\JsonDataResponseFormatter;

/**
 * @var Psr\Http\Message\ResponseFactoryInterface $responseFactory
 */

$factory = new DataResponseFactory($responseFactory);
$dataResponse = $factory->createResponse('test');
$dataResponse = $dataResponse->withResponseFormatter(new JsonDataResponseFormatter());
$dataResponse
    ->getBody()
    ->rewind();

echo $dataResponse->getHeader('Content-Type'); // ["application/json; charset=UTF-8"]
echo $dataResponse
    ->getBody()
    ->getContents(); // "test"

The following formatters are available:

• HtmlDataResponseFormatter
• JsonDataResponseFormatter
• XmlDataResponseFormatter
• PlainTextDataResponseFormatter

Middleware

The package provides a PSR-15 middleware that is able to format a data response.

use Yiisoft\DataResponse\Middleware\FormatDataResponse;
use Yiisoft\DataResponse\Formatter\JsonDataResponseFormatter;

$middleware = (new FormatDataResponse(new JsonDataResponseFormatter()));
//$middleware->process($request, $handler);

Also, the package provides PSR-15 middleware for content negotiation:

use Yiisoft\DataResponse\Formatter\HtmlDataResponseFormatter;
use Yiisoft\DataResponse\Formatter\XmlDataResponseFormatter;
use Yiisoft\DataResponse\Formatter\JsonDataResponseFormatter;
use Yiisoft\DataResponse\Middleware\ContentNegotiator;

$middleware = new ContentNegotiator([
    'text/html' => new HtmlDataResponseFormatter(),
    'application/xml' => new XmlDataResponseFormatter(),
    'application/json' => new JsonDataResponseFormatter(),
]);

You can override middlewares with method withContentFormatters():

$middleware->withContentFormatters([
    'application/xml' => new XmlDataResponseFormatter(),
    'application/json' => new JsonDataResponseFormatter(),
]);

Documentation

• Internals

If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.

License

The Yii Data Response is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.

Support the project

Follow updates

data-response's Issues

withResponseFormatter() should format response right away

When withResponseFormatter() is called, response should be formatter right away.

Remove scrutinizer

Remove usage of yiisoft/serializer

Double formatting of the response body

Good day. Some DataResponse methods cause the response body to be formatted. This causes a marker to be placed about it. But also some immutable methods reset this marker, which leads to repeated formatting. This can lead to both additional processing of large amounts of data or to an error in case of using a "one way" iterator. I think it is necessary to make either an additional marker for the body or not format the body before directly outputting it. Thanks in advance

Use of mutation testing in data-response - Help needed

Hello there!

My name is Ana. I noted that you use the mutation testing tool Infection in the project.
I am a postdoctoral researcher at the University of Seville (Spain), and my colleagues and I are studying how mutation testing tools are used in practice. With this aim in mind, we have analysed over 3,500 public GitHub repositories using mutation testing tools, including yours! This work has recently been published in a journal paper available at https://link.springer.com/content/pdf/10.1007/s10664-022-10177-8.pdf.

To complete this study, we are asking for your help to understand better how mutation testing is used in practice, please! We would be extremely grateful if you could contribute to this study by answering a brief survey of 21 simple questions (no more than 6 minutes). This is the link to the questionnaire https://forms.gle/FvXNrimWAsJYC1zB9.

We apologize if you have already received message multiple times or if you have already had the opportunity to complete the survey. If you have already shared your feedback, we want to convey our appreciation, kindly disregard this message, and please accept our apologies for any inconvenience.

Drop me an e-mail if you have any questions or comments ([email protected]). Thank you very much in advance!!

Raise test coverage to 100%

Add type `mixed` to `$data` parameter in `DataResponseFactoryInterface::createResponse()`

And remove rule MixedTypeRector skiping from rector configuration.

PSR-13 and JsonSerializable in xml

Good day. I have two questions:

1. What about the PSR-13?
2. Wouldn't it be more correct in case XmlDataResponseFormatter gets a JsonSerializable object but not an XmlDataInterface to take the result from the jsonSerialize() method?

update links

What steps will reproduce the problem?

http=>https

Add documentation

Can provide a file download method?

Like https://github.com/yiisoft/yii2/blob/95b0e6010e3960be4e206f9c89c2a4ae5092b86b/framework/web/Response.php

Support send method for download

Php version in scrutinizer

Scrutinizer now uses php 7.3 to run inspections, which is incompatible with minimal requirement of php 7.4.

Loop when formatting the response

What steps will reproduce the problem?

Create formmater which returns Data response

final class Formatter implements DataResponseFormatterInterface
{
    public function format(DataResponse $dataResponse): ResponseInterface
    {
        return $dataResponse->withData('test');
    }
}

What is the expected result?

The response will be formatted

What do you get instead?

Fatal error due to timeout

Additional info

The problem occurs here
https://github.com/yiisoft/data-response/blob/master/src/DataResponse.php#L40

When returning a different response, there is no problem.

Maybe it's better for the formatter to return StreamInterface? Then there will be no such problems

interface DataResponseFormatterInterface
{
    public function format(DataResponse $response): StreamInterface;
}

if ($this->responseFormatter !== null) {
    return $this->dataStream = $this->responseFormatter->format($this);
}

or add processing for this case

$response = $this->responseFormatter->format($this);
if($response instanceof self) {
    throw new Exception('...');
}

Add plain text formatter to `ContentNegotiator` configuration