PHPackages yiisoft/data-response - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Framework](/categories/framework) 4. / 5. yiisoft/data-response ActiveLibrary[Framework](/categories/framework) yiisoft/data-response ===================== Allows responding with data that is automatically converted into PSR-7 response 2.2.0(2mo ago)19287.0k—0.4%11[4 issues](https://github.com/yiisoft/data-response/issues)[1 PRs](https://github.com/yiisoft/data-response/pulls)12BSD-3-ClausePHPPHP 8.1 - 8.5CI passing Since Jun 21Pushed 2mo ago14 watchersCompare [ Source](https://github.com/yiisoft/data-response)[ Packagist](https://packagist.org/packages/yiisoft/data-response)[ Docs](https://www.yiiframework.com/)[ GitHub Sponsors](https://github.com/sponsors/yiisoft)[ OpenCollective](https://opencollective.com/yiisoft)[ RSS](/packages/yiisoft-data-response/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (5)Dependencies (16)Versions (9)Used By (12) [ ![Yii](https://camo.githubusercontent.com/8317c17418b39410a660f5149071d26c5023c0d5fb2b7ebb771324812f666d73/68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667) ](https://github.com/yiisoft) Yii Data Response ================= [](#yii-data-response) [![Latest Stable Version](https://camo.githubusercontent.com/ee2b9efe463d4b469a2a1e19ce4e84e8109e281336cad1b6db8cd659d1bfa660/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f646174612d726573706f6e73652f76)](https://packagist.org/packages/yiisoft/data-response)[![Total Downloads](https://camo.githubusercontent.com/c49b4dda1f523fd209c35fb7410ed45a4d0fe3d03076348fbb3ab1206773b03f/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f646174612d726573706f6e73652f646f776e6c6f616473)](https://packagist.org/packages/yiisoft/data-response)[![Build status](https://github.com/yiisoft/data-response/actions/workflows/build.yml/badge.svg)](https://github.com/yiisoft/data-response/actions/workflows/build.yml)[![Code Coverage](https://camo.githubusercontent.com/2eef6a01eff87a36ebb09d4b3efb591ef28250666e9bf4128e47e54242703bf3/68747470733a2f2f636f6465636f762e696f2f67682f796969736f66742f646174612d726573706f6e73652f67726170682f62616467652e7376673f746f6b656e3d53504558344650464255)](https://codecov.io/gh/yiisoft/data-response)[![Mutation testing badge](https://camo.githubusercontent.com/5f1e87d604c682653eabbad14f7652fbb4c441170350043589e6a008a01b3c13/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f7374796c653d666c61742675726c3d687474707325334125324625324662616467652d6170692e737472796b65722d6d757461746f722e696f2532466769746875622e636f6d253246796969736f6674253246646174612d726573706f6e73652532466d6173746572)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/data-response/master)[![Static analysis](https://github.com/yiisoft/data-response/actions/workflows/static.yml/badge.svg?branch=master)](https://github.com/yiisoft/data-response/actions/workflows/static.yml?query=branch%3Amaster)[![type-coverage](https://camo.githubusercontent.com/882f46fe1ac625effcf3687a821c29892c8f5684769dd186848c08b3a9e5254a/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f646174612d726573706f6e73652f636f7665726167652e737667)](https://shepherd.dev/github/yiisoft/data-response) The package allows responding with data that is automatically converted into [PSR-7](https://www.php-fig.org/psr/psr-7/)response. Requirements ------------ [](#requirements) - PHP 8.1 - 8.5. - `DOM` PHP extension. Installation ------------ [](#installation) The package could be installed with [Composer](https://getcomposer.org): ``` composer require yiisoft/data-response ``` General usage ------------- [](#general-usage) ### Response Factories [](#response-factories) The package provides response factories that create [PSR-7](https://www.php-fig.org/psr/psr-7/) responses with `DataStream` body. The data is formatted lazily when the response body is read. ``` use Yiisoft\DataResponse\ResponseFactory\JsonResponseFactory; use Yiisoft\DataResponse\Formatter\JsonFormatter; /** * @var Psr\Http\Message\ResponseFactoryInterface $responseFactory */ $factory = new JsonResponseFactory($responseFactory, new JsonFormatter()); $response = $factory->createResponse(['key' => 'value']); $response->getBody()->rewind(); echo $response->getBody()->getContents(); // {"key":"value"} echo $response->getHeaderLine('Content-Type'); // application/json; charset=UTF-8 ``` The following response factories are available: - `JsonResponseFactory` — creates responses with JSON-formatted body; - `XmlResponseFactory` — creates responses with XML-formatted body; - `HtmlResponseFactory` — creates responses with HTML-formatted body; - `PlainTextResponseFactory` — creates responses with plain text body; - `DataResponseFactory` — creates responses without a predefined formatter, use middleware to format. ### Middleware [](#middleware) The package provides [PSR-15](https://www.php-fig.org/psr/psr-15/) middleware that formats `DataStream` responses without a predefined formatter. ``` use Yiisoft\DataResponse\Middleware\JsonDataResponseMiddleware; use Yiisoft\DataResponse\Formatter\JsonFormatter; $middleware = new JsonDataResponseMiddleware(new JsonFormatter()); ``` The following middleware are available: - `HtmlDataResponseMiddleware` - `JsonDataResponseMiddleware` - `XmlDataResponseMiddleware` - `PlainTextDataResponseMiddleware` ### Content Negotiation [](#content-negotiation) The package provides content negotiation via middleware and response factory. #### Middleware [](#middleware-1) `ContentNegotiatorDataResponseMiddleware` selects a formatter based on the request's `Accept` header: ``` use Yiisoft\DataResponse\Formatter\HtmlFormatter; use Yiisoft\DataResponse\Formatter\XmlFormatter; use Yiisoft\DataResponse\Formatter\JsonFormatter; use Yiisoft\DataResponse\Middleware\ContentNegotiatorDataResponseMiddleware; $middleware = new ContentNegotiatorDataResponseMiddleware( formatters: [ 'text/html' => new HtmlFormatter(), 'application/xml' => new XmlFormatter(), 'application/json' => new JsonFormatter(), ], fallback: new JsonFormatter(), ); ``` The `fallback` parameter also accepts a `RequestHandlerInterface`, for example `NotAcceptableRequestHandler`to return a 406 response when no formatter matches. #### Response Factory [](#response-factory) `ContentNegotiatorResponseFactory` selects a response factory based on the request's `Accept` header: ``` use Yiisoft\DataResponse\ResponseFactory\ContentNegotiatorResponseFactory; use Yiisoft\DataResponse\ResponseFactory\JsonResponseFactory; use Yiisoft\DataResponse\ResponseFactory\XmlResponseFactory; /** * @var JsonResponseFactory $jsonResponseFactory * @var XmlResponseFactory $xmlResponseFactory */ $factory = new ContentNegotiatorResponseFactory( factories: [ 'application/json' => $jsonResponseFactory, 'application/xml' => $xmlResponseFactory, ], fallback: $jsonResponseFactory, ); $response = $factory->createResponse($request, ['key' => 'value']); ``` The `fallback` parameter also accepts a `RequestHandlerInterface`, for example `NotAcceptableRequestHandler`to return a 406 response when no factory matches. ### DataStream [](#datastream) `DataStream` is a [PSR-7](https://www.php-fig.org/psr/psr-7/) stream that lazily formats data. It wraps raw data and a formatter, and performs formatting only when the stream is read. A formatter is optional at construction time, but must be set before reading the stream, otherwise a `LogicException` will be thrown. ``` use Yiisoft\DataResponse\DataStream\DataStream; use Yiisoft\DataResponse\Formatter\JsonFormatter; use Yiisoft\DataResponse\Formatter\XmlFormatter; $stream = new DataStream(['key' => 'value'], new JsonFormatter()); echo (string) $stream; // {"key":"value"} // You can change the data or formatter dynamically $stream->changeData(['new' => 'data']); $stream->changeFormatter(new XmlFormatter()); ``` Documentation ------------- [](#documentation) - [Deprecated classes](docs/deprecated.md) - [Internals](docs/internals.md) If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that. You may also check out other [Yii Community Resources](https://www.yiiframework.com/community). License ------- [](#license) The Yii Data Response is free software. It is released under the terms of the BSD License. Please see [`LICENSE`](./LICENSE.md) for more information. Maintained by [Yii Software](https://www.yiiframework.com/). Support the project ------------------- [](#support-the-project) [![Open Collective](https://camo.githubusercontent.com/a2b15f8e2268d4e3842e00d41ff7a57cce2ad8bd8d8769c5dc4fa05a546a4f62/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4f70656e253230436f6c6c6563746976652d73706f6e736f722d3765616466313f6c6f676f3d6f70656e253230636f6c6c656374697665266c6f676f436f6c6f723d376561646631266c6162656c436f6c6f723d353535353535)](https://opencollective.com/yiisoft) Follow updates -------------- [](#follow-updates) [![Official website](https://camo.githubusercontent.com/d6b0929173e28cc627430d2519ca1853466a70f37395877eaf4820cb3e1e1909/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f506f77657265645f62792d5969695f4672616d65776f726b2d677265656e2e7376673f7374796c653d666c6174)](https://www.yiiframework.com/)[![Twitter](https://camo.githubusercontent.com/d077c362ac639792171af8bc002ee827816733dfc0925f70b557e6d151022226/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f747769747465722d666f6c6c6f772d3144413146323f6c6f676f3d74776974746572266c6f676f436f6c6f723d314441314632266c6162656c436f6c6f723d3535353535353f7374796c653d666c6174)](https://twitter.com/yiiframework)[![Telegram](https://camo.githubusercontent.com/4e38dd12535575c39c65bea7119b95e663abb2d1f4e3d669a27bbda07ef603f0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f74656c656772616d2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d74656c656772616d)](https://t.me/yii3en)[![Facebook](https://camo.githubusercontent.com/48204e301b34b29b0815854544f04c337fc0692096cab35e9a1f8c53a42c2307/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f66616365626f6f6b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d66616365626f6f6b266c6f676f436f6c6f723d666666666666)](https://www.facebook.com/groups/yiitalk)[![Slack](https://camo.githubusercontent.com/1a3645ba1c97e6684d0349bc478201e1621ba0d3efad516d81035364d442bad7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f736c61636b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d736c61636b)](https://yiiframework.com/go/slack) ### Health Score 61 — FairBetter than 99% of packages Maintenance79 Regular maintenance activity Popularity46 Moderate usage in the ecosystem Community38 Small or concentrated contributor base Maturity74 Established project with proven stability Bus Factor3 3 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~284 days Recently: every ~276 days Total 7 Last Release 85d ago Major Versions 1.0.1 → 2.0.02023-02-15 PHP version history (4 changes)1.0.0PHP ^7.4|^8.0 2.1.0PHP ^8.1 2.1.1PHP 8.1 - 8.4 2.1.2PHP 8.1 - 8.5 ### Community Maintainers ![](https://www.gravatar.com/avatar/261a6249c6f605f3956a2fae40fbb813f6b2e1e6f2bf806180c851a965426e54?d=identicon)[cebe](/maintainers/cebe) ![](https://www.gravatar.com/avatar/fc29e4e7068a00fe9b9db37b8aadda1db6020adcacef810461e47b99c2b150e6?d=identicon)[samdark](/maintainers/samdark) ![](https://www.gravatar.com/avatar/ccb75e3312d6bd454ea445ea308139fd185a4ca906ca5df21cc66e6a35de25a3?d=identicon)[SilverFire](/maintainers/SilverFire) ![](https://www.gravatar.com/avatar/99106256c24a8cb23871b99fa90e48f37f1aa71608c185759b7d2a88683a5918?d=identicon)[hiqsol](/maintainers/hiqsol) --- Top Contributors [![samdark](https://avatars.githubusercontent.com/u/47294?v=4)](https://github.com/samdark "samdark (31 commits)")[![vjik](https://avatars.githubusercontent.com/u/525501?v=4)](https://github.com/vjik "vjik (30 commits)")[![devanych](https://avatars.githubusercontent.com/u/20116244?v=4)](https://github.com/devanych "devanych (18 commits)")[![romkatsu](https://avatars.githubusercontent.com/u/1677515?v=4)](https://github.com/romkatsu "romkatsu (17 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (7 commits)")[![xepozz](https://avatars.githubusercontent.com/u/6815714?v=4)](https://github.com/xepozz "xepozz (5 commits)")[![yiiliveext](https://avatars.githubusercontent.com/u/37578608?v=4)](https://github.com/yiiliveext "yiiliveext (3 commits)")[![luizcmarin](https://avatars.githubusercontent.com/u/67489841?v=4)](https://github.com/luizcmarin "luizcmarin (3 commits)")[![terabytesoftw](https://avatars.githubusercontent.com/u/42547589?v=4)](https://github.com/terabytesoftw "terabytesoftw (3 commits)")[![viktorprogger](https://avatars.githubusercontent.com/u/7670669?v=4)](https://github.com/viktorprogger "viktorprogger (3 commits)")[![mspirkov](https://avatars.githubusercontent.com/u/63721828?v=4)](https://github.com/mspirkov "mspirkov (2 commits)")[![thenotsoft](https://avatars.githubusercontent.com/u/44147615?v=4)](https://github.com/thenotsoft "thenotsoft (2 commits)")[![Arhell](https://avatars.githubusercontent.com/u/26163841?v=4)](https://github.com/Arhell "Arhell (2 commits)")[![Fantom409](https://avatars.githubusercontent.com/u/14968877?v=4)](https://github.com/Fantom409 "Fantom409 (2 commits)")[![roxblnfk](https://avatars.githubusercontent.com/u/4152481?v=4)](https://github.com/roxblnfk "roxblnfk (1 commits)")[![StyleCIBot](https://avatars.githubusercontent.com/u/11048387?v=4)](https://github.com/StyleCIBot "StyleCIBot (1 commits)")[![cebe](https://avatars.githubusercontent.com/u/189796?v=4)](https://github.com/cebe "cebe (1 commits)")[![sankaest](https://avatars.githubusercontent.com/u/21160342?v=4)](https://github.com/sankaest "sankaest (1 commits)") --- Tags hacktoberfestjsonpsr-7responsexmlyii3responsepsr-7data ### Code Quality TestsPHPUnit Static AnalysisPsalm, Rector Code StylePHP CS Fixer Type Coverage Yes ### Embed Badge ![Health badge](/badges/yiisoft-data-response/health.svg) ``` [![Health](https://phpackages.com/badges/yiisoft-data-response/health.svg)](https://phpackages.com/packages/yiisoft-data-response) ``` ### Alternatives [cakephp/cakephp The CakePHP framework 8.8k18.5M1.6k](/packages/cakephp-cakephp)[yiisoft/yii-middleware Yii Middleware 21151.3k1](/packages/yiisoft-yii-middleware)[neos/flow Flow Application Framework 862.0M451](/packages/neos-flow)[cakephp/authentication Authentication plugin for CakePHP 1153.6M67](/packages/cakephp-authentication)[cakephp/authorization Authorization abstraction layer plugin for CakePHP 742.2M34](/packages/cakephp-authorization)[yiisoft/cookies Convenient way to use cookies with PSR-7 22333.4k4](/packages/yiisoft-cookies) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)