README

Yii Input HTTP

The package provides Yii Hydrator attributes to get data from PSR-7 HTTP request and adds extra abilities to middlewares processed by Yii 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:

composer require yiisoft/input-http

General usage

Yii Input HTTP allows having DTO with attributes like this:

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:

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 middleware to prepare it.

Basic steps:

Configure storing request.
Configure parameters resolver.
Create DTO (request input).
Mark DTO properties with hydrator attributes 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, Português - Brasil.
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 Input HTTP is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.

yiisoft / input-http

Maintainers

Details