PHPackages                             yiisoft/request-model - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. yiisoft/request-model

AbandonedArchivedLibrary[Framework](/categories/framework)

yiisoft/request-model
=====================

Yii Framework Request Model

1542.8k↓33.3%9[7 issues](https://github.com/yiisoft/request-model/issues)PHP

Since Mar 8Pushed 2y ago14 watchersCompare

[ Source](https://github.com/yiisoft/request-model)[ Packagist](https://packagist.org/packages/yiisoft/request-model)[ RSS](/packages/yiisoft-request-model/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (3)Used By (0)

  **This package is deprecated. Use [Yii Input HTTP](https://github.com/yiisoft/input-http) instead.**

 ❌

---

 [ ![](https://camo.githubusercontent.com/8317c17418b39410a660f5149071d26c5023c0d5fb2b7ebb771324812f666d73/68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667) ](https://github.com/yiisoft)

Yii Request Model
=================

[](#yii-request-model)

[![Latest Stable Version](https://camo.githubusercontent.com/e6cb3b480d33ca8f4cb71ca1ad40c54838aa5f924a9e19c20b2f66ee9fdd33bc/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f726571756573742d6d6f64656c2f762f737461626c652e706e67)](https://packagist.org/packages/yiisoft/request-model)[![Total Downloads](https://camo.githubusercontent.com/58ee5eb50979e59d401f42b3e510293d65de63b15c3b67cefb54ba7c2635c5ff/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f726571756573742d6d6f64656c2f646f776e6c6f6164732e706e67)](https://packagist.org/packages/yiisoft/request-model)[![Build status](https://github.com/yiisoft/request-model/workflows/build/badge.svg)](https://github.com/yiisoft/request-model/actions?query=workflow%3Abuild)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/435928cafa99f9e3ef1a7f4d01f1e035d8a6ad222449131fd9f6f9034dd5986a/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f796969736f66742f726571756573742d6d6f64656c2f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/yiisoft/request-model/?branch=master)[![Code Coverage](https://camo.githubusercontent.com/da68f013049b0a5a9fd3c4b9b7f10369f2a749a19c985729a96f15fe3f6dd1c3/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f796969736f66742f726571756573742d6d6f64656c2f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/yiisoft/request-model/?branch=master)[![Mutation testing badge](https://camo.githubusercontent.com/a520e18d4cb405f52aeb7cb2e78297363022616cd07d361759ddec588c8106b6/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f7374796c653d666c61742675726c3d687474707325334125324625324662616467652d6170692e737472796b65722d6d757461746f722e696f2532466769746875622e636f6d253246796969736f6674253246726571756573742d6d6f64656c2532466d6173746572)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/request-model/master)[![static analysis](https://github.com/yiisoft/request-model/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/request-model/actions?query=workflow%3A%22static+analysis%22)[![type-coverage](https://camo.githubusercontent.com/5e5a73a97d7fca88e6a9de0a1b7418d687b91789873c4c04ba852265384415f5/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f726571756573742d6d6f64656c2f636f7665726167652e737667)](https://shepherd.dev/github/yiisoft/request-model)

Request model simplifies working with request data. It allows you to decorate data for easy retrieval and automatically validate it when needed.

Requirements
------------

[](#requirements)

- PHP 8.0 or higher.

Installation
------------

[](#installation)

The package could be installed with composer:

```
composer require yiisoft/request-model

```

According to [`yiisoft/middleware-dispatcher`](https://github.com/yiisoft/middleware-dispatcher) docs, you need to set the implementation of `ParametersResolverInterface` to `HandlerParametersResolver` via container or pass directly.

General usage
-------------

[](#general-usage)

A simple version of the request model looks like the following:

```
use Yiisoft\RequestModel\RequestModel;
use Yiisoft\Validator\RulesProviderInterface;
use Yiisoft\Validator\Rule\Email;
use Yiisoft\Validator\Rule\Required;

final class AuthRequest extends RequestModel implements RulesProviderInterface
{
    public function getLogin(): string
    {
        return (string)$this->getAttributeValue('body.login');
    }

    public function getPassword(): string
    {
        return (string)$this->getAttributeValue('body.password');
    }

    public function getRules(): array
    {
        return [
            'body.login' => [
                new Required(),
                new Email(),
            ],
            'body.password' => [
                new Required(),
            ]
        ];
    }
}
```

Route:

```
 Route::post('/test')
    ->action([SimpleController::class, 'action'])
    ->name('site/test')
```

Usage in controller:

```
use Psr\Http\Message\ResponseInterface;

final class SimpleController
{
    public function action(AuthRequest $request): ResponseInterface
    {
        echo $request->getLogin();
        ...
    }
}
```

If the data does not pass validation, `RequestValidationException` will be thrown. If you need to handle an exception and, for example, send a response, you can intercept its middleware.

For example:

```
final class ExceptionMiddleware implements MiddlewareInterface
{
    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
    {
        try {
            return $handler->handle($request);
        } catch (RequestValidationException $e) {
            return new Response(400, [], $e->getFirstError());
        }
    }
}
```

You can use the request model without validation. To do this, you need to remove the `ValidatableModelInterface`. In this case, the data will be included into the model, but will not be validated. For example:

```
final class ViewPostRequest extends RequestModel
{
    public function getId(): int
    {
        return (int)$this->getAttributeValue('router.id');
    }
}
```

Inside the request model class, data is available using the following keys:

keysourcequery$request->getQueryParams()body$request->getParsedBody()attributes$request->getAttributes()headers$request->getHeaders()files$request->getUploadedFiles()cookie$request->getCookieParams()router$currentRoute->getArguments()This data can be obtained as follows

```
$this->requestData['router']['id'];
```

or through the methods

```
$this->hasAttribute('body.user_id');
$this->getAttributeValue('body.user_id');
```

#### Attributes

[](#attributes)

You can use attributes in an action handler to get data from a request:

```
use Psr\Http\Message\ResponseInterface;
use Yiisoft\RequestModel\Attribute\Request;
use Yiisoft\RequestModel\Attribute\Route;

final class SimpleController
{
    public function action(#[Route('id')] int $id, #[Request('foo')] $attribute,): ResponseInterface
    {
        echo $id;
        //...
    }
}
```

Attributes are also supported in closure actions.

There are several attributes out of the box:

NameSourceBodyParsed body of requestQueryQuery parameter of URIRequestAttribute of requestRouteArgument of current routeUploadedFilesUploaded files of request### Unit testing

[](#unit-testing)

The package is tested with [PHPUnit](https://phpunit.de/). To run tests:

```
./vendor/bin/phpunit
```

### Mutation testing

[](#mutation-testing)

The package tests are checked with [Infection](https://infection.github.io/) mutation framework. To run it:

```
./vendor/bin/infection
```

### Static analysis

[](#static-analysis)

The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis:

```
./vendor/bin/psalm
```

### Support the project

[](#support-the-project)

[![Open Collective](https://camo.githubusercontent.com/a2b15f8e2268d4e3842e00d41ff7a57cce2ad8bd8d8769c5dc4fa05a546a4f62/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4f70656e253230436f6c6c6563746976652d73706f6e736f722d3765616466313f6c6f676f3d6f70656e253230636f6c6c656374697665266c6f676f436f6c6f723d376561646631266c6162656c436f6c6f723d353535353535)](https://opencollective.com/yiisoft)

### Follow updates

[](#follow-updates)

[![Official website](https://camo.githubusercontent.com/d6b0929173e28cc627430d2519ca1853466a70f37395877eaf4820cb3e1e1909/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f506f77657265645f62792d5969695f4672616d65776f726b2d677265656e2e7376673f7374796c653d666c6174)](https://www.yiiframework.com/)[![Twitter](https://camo.githubusercontent.com/d077c362ac639792171af8bc002ee827816733dfc0925f70b557e6d151022226/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f747769747465722d666f6c6c6f772d3144413146323f6c6f676f3d74776974746572266c6f676f436f6c6f723d314441314632266c6162656c436f6c6f723d3535353535353f7374796c653d666c6174)](https://twitter.com/yiiframework)[![Telegram](https://camo.githubusercontent.com/4e38dd12535575c39c65bea7119b95e663abb2d1f4e3d669a27bbda07ef603f0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f74656c656772616d2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d74656c656772616d)](https://t.me/yii3en)[![Facebook](https://camo.githubusercontent.com/48204e301b34b29b0815854544f04c337fc0692096cab35e9a1f8c53a42c2307/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f66616365626f6f6b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d66616365626f6f6b266c6f676f436f6c6f723d666666666666)](https://www.facebook.com/groups/yiitalk)[![Slack](https://camo.githubusercontent.com/1a3645ba1c97e6684d0349bc478201e1621ba0d3efad516d81035364d442bad7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f736c61636b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d736c61636b)](https://yiiframework.com/go/slack)

License
-------

[](#license)

The Yii Request Model 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/).

###  Health Score

26

—

LowBetter than 43% of packages

Maintenance11

Infrequent updates — may be unmaintained

Popularity37

Limited adoption so far

Community28

Small or concentrated contributor base

Maturity26

Early-stage or recently created project

 Bus Factor4

4 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/261a6249c6f605f3956a2fae40fbb813f6b2e1e6f2bf806180c851a965426e54?d=identicon)[cebe](/maintainers/cebe)

![](https://www.gravatar.com/avatar/fc29e4e7068a00fe9b9db37b8aadda1db6020adcacef810461e47b99c2b150e6?d=identicon)[samdark](/maintainers/samdark)

![](https://www.gravatar.com/avatar/ccb75e3312d6bd454ea445ea308139fd185a4ca906ca5df21cc66e6a35de25a3?d=identicon)[SilverFire](/maintainers/SilverFire)

![](https://www.gravatar.com/avatar/99106256c24a8cb23871b99fa90e48f37f1aa71608c185759b7d2a88683a5918?d=identicon)[hiqsol](/maintainers/hiqsol)

---

Top Contributors

[![samdark](https://avatars.githubusercontent.com/u/47294?v=4)](https://github.com/samdark "samdark (17 commits)")[![vjik](https://avatars.githubusercontent.com/u/525501?v=4)](https://github.com/vjik "vjik (13 commits)")[![rustamwin](https://avatars.githubusercontent.com/u/16498265?v=4)](https://github.com/rustamwin "rustamwin (11 commits)")[![xepozz](https://avatars.githubusercontent.com/u/6815714?v=4)](https://github.com/xepozz "xepozz (11 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (10 commits)")[![devanych](https://avatars.githubusercontent.com/u/20116244?v=4)](https://github.com/devanych "devanych (8 commits)")[![romkatsu](https://avatars.githubusercontent.com/u/1677515?v=4)](https://github.com/romkatsu "romkatsu (5 commits)")[![terabytesoftw](https://avatars.githubusercontent.com/u/42547589?v=4)](https://github.com/terabytesoftw "terabytesoftw (4 commits)")[![StyleCIBot](https://avatars.githubusercontent.com/u/11048387?v=4)](https://github.com/StyleCIBot "StyleCIBot (3 commits)")[![githubjeka](https://avatars.githubusercontent.com/u/874234?v=4)](https://github.com/githubjeka "githubjeka (2 commits)")[![arogachev](https://avatars.githubusercontent.com/u/8326201?v=4)](https://github.com/arogachev "arogachev (2 commits)")[![yiiliveext](https://avatars.githubusercontent.com/u/37578608?v=4)](https://github.com/yiiliveext "yiiliveext (1 commits)")[![Fantom409](https://avatars.githubusercontent.com/u/14968877?v=4)](https://github.com/Fantom409 "Fantom409 (1 commits)")[![roxblnfk](https://avatars.githubusercontent.com/u/4152481?v=4)](https://github.com/roxblnfk "roxblnfk (1 commits)")[![sankaest](https://avatars.githubusercontent.com/u/21160342?v=4)](https://github.com/sankaest "sankaest (1 commits)")[![viktorprogger](https://avatars.githubusercontent.com/u/7670669?v=4)](https://github.com/viktorprogger "viktorprogger (1 commits)")[![alekciy](https://avatars.githubusercontent.com/u/427741?v=4)](https://github.com/alekciy "alekciy (1 commits)")

---

Tags

hacktoberfestpsr-7requestvalidationyii3

### Embed Badge

![Health badge](/badges/yiisoft-request-model/health.svg)

```
[![Health](https://phpackages.com/badges/yiisoft-request-model/health.svg)](https://phpackages.com/packages/yiisoft-request-model)
```

###  Alternatives

[laravel/telescope

An elegant debug assistant for the Laravel framework.

5.2k67.8M192](/packages/laravel-telescope)[spiral/roadrunner

RoadRunner: High-performance PHP application server and process manager written in Go and powered with plugins

8.4k12.2M84](/packages/spiral-roadrunner)[nolimits4web/swiper

Most modern mobile touch slider and framework with hardware accelerated transitions

41.8k177.2k1](/packages/nolimits4web-swiper)[laravel/dusk

Laravel Dusk provides simple end-to-end testing and browser automation.

1.9k36.7M259](/packages/laravel-dusk)[laravel/prompts

Add beautiful and user-friendly forms to your command-line applications.

708181.8M596](/packages/laravel-prompts)[cakephp/chronos

A simple API extension for DateTime.

1.4k47.7M121](/packages/cakephp-chronos)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)