request-input.md

Request input

Request input is a DTO implementing RequestInputInterface:

use Yiisoft\Input\Http\AbstractInput;
use Yiisoft\Input\Http\RequestInputInterface;
use Yiisoft\Validator\Rule\Required;

final class UpdatePostInput implements RequestInputInterface 
{
    public int $id;
    public string $title;
    public string $description = '';
    public string $content;
}

It can be prepared to be filled automatically from request's parameters using attributes:

use Yiisoft\Input\Http\AbstractInput;
use Yiisoft\Input\Http\Attribute\Data\FromBody;
use Yiisoft\Input\Http\RequestInputInterface;
use Yiisoft\Validator\Rule\Required;

#[FromBody]
final class UpdatePostInput implements RequestInputInterface 
{
    public int $id;
    public string $title;
    public string $description = '';
    public string $content;
}

For more available options, see Hydrator attributes section.

The main concept of request input is to ease automatic filling with according resolver. It's possible to use hydrator directly too, though.

Combining with validation

If you need validation features additionally, extend the DTO from AbstractInput class which also implements ValidatedInputInterface. This way you can use validation attributes for properties:

use Yiisoft\Input\Http\Attribute\Data\FromBody

;use Yiisoft\Validator\Rule\Integer;
use Yiisoft\Validator\Rule\Length;
use Yiisoft\Validator\Rule\Required;
use Yiisoft\Validator\Rule\StringValue;

#[FromBody]
final class UpdatePostInput extends AbstractInput
{
    public function __construct(
        #[Required]
        #[Integer(min: 1)]
        public int $id;
        #[Required]
        #[StringValue]
        #[Length(max: 100)]
        public string $title;
        #[Length(max: 255)]
        #[StringValue]
        public string $description = '';
        #[Required]
        #[StringValue]
        public string $content;
    ) {
    }
}

Thus, when filled, the DTO can be validated right away, and you will be able to retrieve the validation result:

use Yiisoft\Hydrator\Validator\ValidatedInputInterface;

/** @var ValidatedInputInterface $person */
$result = $person->getValidationResult();
$isValid = $result->isValid();
$errorMessagesMap = $result->getErrorMessagesIndexedByPath();

More thorough guide for working with the validation result is available in the validator guide.