{"id":14966352,"url":"https://github.com/yiisoft/data-response","last_synced_at":"2025-10-19T09:31:12.840Z","repository":{"id":39906350,"uuid":"279689827","full_name":"yiisoft/data-response","owner":"yiisoft","description":null,"archived":false,"fork":false,"pushed_at":"2024-03-03T06:02:19.000Z","size":189,"stargazers_count":18,"open_issues_count":5,"forks_count":12,"subscribers_count":18,"default_branch":"master","last_synced_at":"2024-04-15T03:03:04.421Z","etag":null,"topics":["hacktoberfest","json","psr-7","response","xml","yii3"],"latest_commit_sha":null,"homepage":"https://www.yiiframework.com/","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yiisoft.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null},"funding":{"open_collective":"yiisoft","github":["yiisoft"]}},"created_at":"2020-07-14T20:47:55.000Z","updated_at":"2024-04-13T14:37:01.000Z","dependencies_parsed_at":"2024-03-04T12:05:20.968Z","dependency_job_id":"90ada264-411e-4b9f-84a9-2b4308d9f9a1","html_url":"https://github.com/yiisoft/data-response","commit_stats":{"total_commits":102,"total_committers":18,"mean_commits":5.666666666666667,"dds":0.696078431372549,"last_synced_commit":"749cefa429390acc043ac411463f8c17499a762f"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":"yiisoft/package-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yiisoft%2Fdata-response","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yiisoft%2Fdata-response/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yiisoft%2Fdata-response/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yiisoft%2Fdata-response/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yiisoft","download_url":"https://codeload.github.com/yiisoft/data-response/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219869926,"owners_count":16555204,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest","json","psr-7","response","xml","yii3"],"created_at":"2024-09-24T13:36:15.604Z","updated_at":"2025-10-19T09:31:12.831Z","avatar_url":"https://github.com/yiisoft.png","language":"PHP","funding_links":["https://opencollective.com/yiisoft","https://github.com/sponsors/yiisoft"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/yiisoft\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://yiisoft.github.io/docs/images/yii_logo.svg\" height=\"100px\" alt=\"Yii\"\u003e\n    \u003c/a\u003e\n    \u003ch1 align=\"center\"\u003eYii Data Response\u003c/h1\u003e\n    \u003cbr\u003e\n\u003c/p\u003e\n\n[![Latest Stable Version](https://poser.pugx.org/yiisoft/data-response/v)](https://packagist.org/packages/yiisoft/data-response)\n[![Total Downloads](https://poser.pugx.org/yiisoft/data-response/downloads)](https://packagist.org/packages/yiisoft/data-response)\n[![Build status](https://github.com/yiisoft/data-response/actions/workflows/build.yml/badge.svg)](https://github.com/yiisoft/data-response/actions/workflows/build.yml)\n[![Code Coverage](https://codecov.io/gh/yiisoft/data-response/graph/badge.svg?token=SPEX4FPFBU)](https://codecov.io/gh/yiisoft/data-response)\n[![Mutation testing badge](https://img.shields.io/endpoint?style=flat\u0026url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fyiisoft%2Fdata-response%2Fmaster)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/data-response/master)\n[![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)\n[![type-coverage](https://shepherd.dev/github/yiisoft/data-response/coverage.svg)](https://shepherd.dev/github/yiisoft/data-response)\n\nThe package allows responding with data that is automatically converted into [PSR-7](https://www.php-fig.org/psr/psr-7/)\nresponse.\n\n## Requirements\n\n- PHP 8.1 or higher.\n- `DOM` PHP extension.\n\n## Installation\n\nThe package could be installed with [Composer](https://getcomposer.org):\n\n```shell\ncomposer require yiisoft/data-response\n```\n\n## General usage\n\nThe package provides `DataResponseFactory` class that, given a [PSR-17](https://www.php-fig.org/psr/psr-17/)\nresponse factory, is able to create data response.\n\nData response contains raw data to be processed later.\n\n```php\nuse Yiisoft\\DataResponse\\DataResponseFactory;\n\n/**\n * @var Psr\\Http\\Message\\ResponseFactoryInterface $responseFactory\n */\n\n$factory = new DataResponseFactory($responseFactory);\n$dataResponse = $factory-\u003ecreateResponse('test');\n$dataResponse\n    -\u003egetBody()\n    -\u003erewind();\n\necho $dataResponse\n    -\u003egetBody()\n    -\u003egetContents(); // \"test\"\n```\n\n### Formatters\n\nFormatter purpose is to format a data response. In the following example we format data as JSON.\n\n```php\nuse Yiisoft\\DataResponse\\DataResponseFactory;\nuse Yiisoft\\DataResponse\\Formatter\\JsonDataResponseFormatter;\n\n/**\n * @var Psr\\Http\\Message\\ResponseFactoryInterface $responseFactory\n */\n\n$factory = new DataResponseFactory($responseFactory);\n$dataResponse = $factory-\u003ecreateResponse('test');\n$dataResponse = $dataResponse-\u003ewithResponseFormatter(new JsonDataResponseFormatter());\n$dataResponse\n    -\u003egetBody()\n    -\u003erewind();\n\necho $dataResponse-\u003egetHeader('Content-Type'); // [\"application/json; charset=UTF-8\"]\necho $dataResponse\n    -\u003egetBody()\n    -\u003egetContents(); // \"test\"\n```\n\nThe following formatters are available:\n\n- `HtmlDataResponseFormatter`\n- `JsonDataResponseFormatter`\n- `XmlDataResponseFormatter`\n- `PlainTextDataResponseFormatter`\n\n### Middleware\n\nThe package provides a [PSR-15](https://www.php-fig.org/psr/psr-15/) middleware that is able to format a data response.\n\n```php\nuse Yiisoft\\DataResponse\\Middleware\\FormatDataResponse;\nuse Yiisoft\\DataResponse\\Formatter\\JsonDataResponseFormatter;\n\n$middleware = (new FormatDataResponse(new JsonDataResponseFormatter()));\n//$middleware-\u003eprocess($request, $handler);\n```\n\nAlso, the package provides [PSR-15](https://www.php-fig.org/psr/psr-15/) middleware for content negotiation:\n\n```php\nuse Yiisoft\\DataResponse\\Formatter\\HtmlDataResponseFormatter;\nuse Yiisoft\\DataResponse\\Formatter\\XmlDataResponseFormatter;\nuse Yiisoft\\DataResponse\\Formatter\\JsonDataResponseFormatter;\nuse Yiisoft\\DataResponse\\Middleware\\ContentNegotiator;\n\n$middleware = new ContentNegotiator([\n    'text/html' =\u003e new HtmlDataResponseFormatter(),\n    'application/xml' =\u003e new XmlDataResponseFormatter(),\n    'application/json' =\u003e new JsonDataResponseFormatter(),\n]);\n```\n\nYou can override middlewares with method `withContentFormatters()`:\n\n```php\n$middleware-\u003ewithContentFormatters([\n    'application/xml' =\u003e new XmlDataResponseFormatter(),\n    'application/json' =\u003e new JsonDataResponseFormatter(),\n]);\n```\n\n## Documentation\n\n- [Internals](docs/internals.md)\n\nIf 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.\nYou may also check out other [Yii Community Resources](https://www.yiiframework.com/community).\n\n## License\n\nThe Yii Data Response is free software. It is released under the terms of the BSD License.\nPlease see [`LICENSE`](./LICENSE.md) for more information.\n\nMaintained by [Yii Software](https://www.yiiframework.com/).\n\n## Support the project\n\n[![Open Collective](https://img.shields.io/badge/Open%20Collective-sponsor-7eadf1?logo=open%20collective\u0026logoColor=7eadf1\u0026labelColor=555555)](https://opencollective.com/yiisoft)\n\n## Follow updates\n\n[![Official website](https://img.shields.io/badge/Powered_by-Yii_Framework-green.svg?style=flat)](https://www.yiiframework.com/)\n[![Twitter](https://img.shields.io/badge/twitter-follow-1DA1F2?logo=twitter\u0026logoColor=1DA1F2\u0026labelColor=555555?style=flat)](https://twitter.com/yiiframework)\n[![Telegram](https://img.shields.io/badge/telegram-join-1DA1F2?style=flat\u0026logo=telegram)](https://t.me/yii3en)\n[![Facebook](https://img.shields.io/badge/facebook-join-1DA1F2?style=flat\u0026logo=facebook\u0026logoColor=ffffff)](https://www.facebook.com/groups/yiitalk)\n[![Slack](https://img.shields.io/badge/slack-join-1DA1F2?style=flat\u0026logo=slack)](https://yiiframework.com/go/slack)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyiisoft%2Fdata-response","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyiisoft%2Fdata-response","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyiisoft%2Fdata-response/lists"}