yiisoft/input-http

Maps data from PSR-7 HTTP request to PHP DTO representing user input.

1.0.0 2024-03-07 12:33 UTC

This package is auto-updated.

Last update: 2024-06-19 13:48:25 UTC


README

Yii

Yii Input HTTP


Latest Stable Version Total Downloads Build status Code Coverage Mutation testing badge static analysis type-coverage psalm-level

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 to have 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;
    }
}

Basic steps:

Documentation

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.

Support the project

Open Collective

Follow updates

Official website Twitter Telegram Facebook Slack