Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yiisoft/request-model
https://github.com/yiisoft/request-model
hacktoberfest psr-7 request validation yii3
Last synced: 1 day ago
JSON representation
- Host: GitHub
- URL: https://github.com/yiisoft/request-model
- Owner: yiisoft
- License: bsd-3-clause
- Archived: true
- Created: 2020-10-12T09:49:54.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-10-10T13:06:51.000Z (over 1 year ago)
- Last Synced: 2024-10-29T22:38:37.645Z (3 months ago)
- Topics: hacktoberfest, psr-7, request, validation, yii3
- Language: PHP
- Homepage: https://www.yiiframework.com/
- Size: 148 KB
- Stars: 15
- Watchers: 17
- Forks: 9
- Open Issues: 8
-
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
This package is deprecated. Use
Yii Input HTTP instead.
❌
---
Yii Request Model
[](https://packagist.org/packages/yiisoft/request-model)
[](https://packagist.org/packages/yiisoft/request-model)
[](https://github.com/yiisoft/request-model/actions?query=workflow%3Abuild)
[](https://scrutinizer-ci.com/g/yiisoft/request-model/?branch=master)
[](https://scrutinizer-ci.com/g/yiisoft/request-model/?branch=master)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/request-model/master)
[](https://github.com/yiisoft/request-model/actions?query=workflow%3A%22static+analysis%22)
[](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
- PHP 8.0 or higher.
## 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
A simple version of the request model looks like the following:
```php
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:
```php
Route::post('/test')
->action([SimpleController::class, 'action'])
->name('site/test')
```
Usage in controller:
```php
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:
```php
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:
```php
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:
| key | source |
|------------|-------------------------------|
| query | $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
```php
$this->requestData['router']['id'];
```
or through the methods
```php
$this->hasAttribute('body.user_id');
$this->getAttributeValue('body.user_id');
```
#### Attributes
You can use attributes in an action handler to get data from a request:
```php
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:
| Name | Source |
|---------------|---------------------------|
| Body | Parsed body of request |
| Query | Query parameter of URI |
| Request | Attribute of request |
| Route | Argument of current route |
| UploadedFiles | Uploaded files of request |
### Unit testing
The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
```shell
./vendor/bin/phpunit
```
### Mutation testing
The package tests are checked with [Infection](https://infection.github.io/) mutation framework. To run it:
```shell
./vendor/bin/infection
```
### Static analysis
The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis:
```shell
./vendor/bin/psalm
```
### 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)
## 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/).