yiisoft/data-response

Allows responding with data that is automatically converted into PSR-7 response

2.1.0 2024-03-03 06:01 UTC

Requires

• php: ^8.1
• ext-dom: *
• psr/http-factory: ^1.0
• psr/http-message: ^1.0|^2.0
• psr/http-server-handler: ^1.0
• psr/http-server-middleware: ^1.0
• yiisoft/http: ^1.2
• yiisoft/json: ^1.0
• yiisoft/strings: ^2.0

Requires (Dev)

• httpsoft/http-message: ^1.0
• maglnet/composer-require-checker: ^4.7
• phpunit/phpunit: ^10.5
• rector/rector: ^1.0
• roave/infection-static-analysis-plugin: ^1.16
• spatie/phpunit-watcher: ^1.23
• vimeo/psalm: ^5.22
• yiisoft/di: ^1.1

BSD-3-Clause

• data
• response
• psr-7

README

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