https://github.com/yiisoft/data-response
https://github.com/yiisoft/data-response
hacktoberfest json psr-7 response xml yii3
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/yiisoft/data-response
- Owner: yiisoft
- License: bsd-3-clause
- Created: 2020-07-14T20:47:55.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-03T06:02:19.000Z (over 1 year ago)
- Last Synced: 2024-04-15T03:03:04.421Z (about 1 year ago)
- Topics: hacktoberfest, json, psr-7, response, xml, yii3
- Language: PHP
- Homepage: https://www.yiiframework.com/
- Size: 185 KB
- Stars: 18
- Watchers: 18
- Forks: 12
- Open Issues: 5
-
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
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Yii Data Response
[](https://packagist.org/packages/yiisoft/data-response)
[](https://packagist.org/packages/yiisoft/data-response)
[](https://github.com/yiisoft/data-response/actions?query=workflow%3Abuild)
[](https://codecov.io/gh/yiisoft/data-response)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/data-response/master)
[](https://github.com/yiisoft/data-response/actions?query=workflow%3A%22static+analysis%22)
[](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
- PHP 8.1 or higher.
- `DOM` PHP extension.
## Installation
The package could be installed with [Composer](https://getcomposer.org):
```shell
composer require yiisoft/data-response
```
## General usage
The package provides `DataResponseFactory` class that, given a [PSR-17](https://www.php-fig.org/psr/psr-17/)
response factory, is able to create data response.
Data response contains raw data to be processed later.
```php
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.
```php
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](https://www.php-fig.org/psr/psr-15/) middleware that is able to format a data response.
```php
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](https://www.php-fig.org/psr/psr-15/) middleware for content negotiation:
```php
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()`:
```php
$middleware->withContentFormatters([
'application/xml' => new XmlDataResponseFormatter(),
'application/json' => new JsonDataResponseFormatter(),
]);
```
## Documentation
- [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
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
[](https://opencollective.com/yiisoft)
## Follow updates
[](https://www.yiiframework.com/)
[](https://twitter.com/yiiframework)
[](https://t.me/yii3en)
[](https://www.facebook.com/groups/yiitalk)
[](https://yiiframework.com/go/slack)