vi-tech / dto-bundle
symfony项目的DTO解析器
3.0.1
2022-02-01 11:51 UTC
Requires
- php: ^7.3|~8.0.0|^8.1
- ext-json: *
- spatie/data-transfer-object: ^1.13|^2.5
- symfony/dependency-injection: ^4.1|^5.0|^6.0
- symfony/http-kernel: ^4.1|^5.1|^6.0
Requires (Dev)
- php-coveralls/php-coveralls: ^2.2
- phpunit/phpunit: ^9.3
- roave/security-advisories: dev-master
- squizlabs/php_codesniffer: ^3.5
This package is auto-updated.
Last update: 2024-08-29 05:37:49 UTC
README
为symfony应用程序自动将请求转换为预定义结构的包。
安装
$ composer require vi-tech/dto-bundle
在配置中声明bundle
// config/bundles.php return [ \ViTech\DataObjectBundle\DataObjectBundle::class => ['all' => true], ];
使用方法
<?php use Symfony\Component\HttpFoundation\Response; use ViTech\DataObjectBundle\Object\AbstractObject; class RegistrationDto extends AbstractObject { /** @var string */ public $login; /** @var string */ public $password; } class RegistrationController { public function __invoke(RegistrationDto $registration): Response { // Register new user using $registration // $registration->login contains Request::$request->get('login'). Same for password. return new Response(); } }
RegistrationDto $registration
中的数据与Request::$request属性匹配。
如果请求包含未在DTO中声明的属性,则这些属性将被忽略。
在属性类型不匹配的情况下,将抛出Symfony\Component\HttpKernel\Exception\BadRequestHttpException
。
在应用程序内验证DTO是一种常见做法。
最简单的方法是为相同的DTO声明约束注解并使用symfony验证器。
<?php use Symfony\Component\HttpFoundation\Response; use ViTech\DataObjectBundle\Object\AbstractObject; use Symfony\Component\Validator\Validator\ValidatorInterface; class RegistrationDto extends AbstractObject { /** * @Assert\NotBlank() * @Assert\UniqueLogin() * * @var string */ public $login; /** * @Assert\NotBlank() * @Assert\PasswordRules() * * @var string */ public $password; } class RegistrationController { /** @var ValidatorInterface */ private $validator; public function __invoke(RegistrationDto $registration): Response { $violations = $this->validator->validate($registration); if (count($violations)) { // Handle constraints violations } // register new user using $registration return new Response(); } }