https://github.com/yiisoft/input-http
Provides Yii Hydrator attributes to get data from PSR-7 HTTP request and adds extra abilities to middlewares processed by Yii Middleware Dispatcher.
https://github.com/yiisoft/input-http
http hydrator middleware yii3
Last synced: 4 months ago
JSON representation
Provides Yii Hydrator attributes to get data from PSR-7 HTTP request and adds extra abilities to middlewares processed by Yii Middleware Dispatcher.
- Host: GitHub
- URL: https://github.com/yiisoft/input-http
- Owner: yiisoft
- License: bsd-3-clause
- Created: 2023-04-27T10:04:38.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-08T15:15:10.000Z (about 1 year ago)
- Last Synced: 2024-04-13T23:13:21.778Z (about 1 year ago)
- Topics: http, hydrator, middleware, yii3
- Language: PHP
- Homepage: https://www.yiiframework.com
- Size: 71.3 KB
- Stars: 10
- Watchers: 16
- Forks: 2
- Open Issues: 2
-
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 Input HTTP
[](https://packagist.org/packages/yiisoft/input-http)
[](https://packagist.org/packages/yiisoft/input-http)
[](https://github.com/yiisoft/input-http/actions/workflows/build.yml)
[](https://codecov.io/gh/yiisoft/input-http)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/input-http/master)
[](https://github.com/yiisoft/input-http/actions?query=workflow%3A%22static+analysis%22)
[](https://shepherd.dev/github/yiisoft/input-http)
[](https://shepherd.dev/github/yiisoft/input-http)
The package provides [Yii Hydrator](https://github.com/yiisoft/hydrator) attributes
to get data from [PSR-7 HTTP request](https://www.php-fig.org/psr/psr-7/) and adds extra abilities to middlewares
processed by [Yii Middleware Dispatcher](https://github.com/yiisoft/middleware-dispatcher):
- maps data from PSR-7 HTTP request to PHP DTO representing user input;
- uses Yii Hydrator parameter attributes for resolving middleware parameters.
## Requirements
- PHP 8.1 or higher.
## Installation
The package could be installed with [Composer](https://getcomposer.org):
```shell
composer require yiisoft/input-http
```
## General usage
Yii Input HTTP allows having DTO with attributes like this:
```php
use Yiisoft\Input\Http\AbstractInput;
use Yiisoft\Input\Http\Attribute\Data\FromBody;
#[FromBody]
final class UpdatePostInput extends AbstractInput
{
public int $id;
public string $title;
public string $description = '';
public string $content;
}
```
and automatically resolve and hydrate it, for example, for arguments like that:
```php
final class UpdatePostController
{
public function update(UpdatePostInput $post): ResponseInterface
{
// ...
/** @var ResponseInterface $response */
return $response;
}
}
```
Note that `FromBody` attribute assumes that request body is parsed. If your implementation of request doesn't parse body
automatically, you can use [yiisoft/request-body-parser](https://github.com/yiisoft/request-body-parser) middleware
to prepare it.
Basic steps:
- Configure [storing request](https://github.com/yiisoft/request-provider?tab=readme-ov-file#general-usage).
- Configure [parameters resolver](docs/guide/en/parameters-resolvers.md).
- Create DTO ([request input](docs/guide/en/request-input.md)).
- Mark DTO properties with [hydrator attributes](docs/guide/en/hydrator-attributes.md) provided by this package.
- Add DTO class name as a type hint to a class method argument where you want to it to be resolved.
## Documentation
- Guide: [English](docs/guide/en/README.md), [Português - Brasil](docs/guide/pt-BR/README.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
The Yii Input HTTP 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)