Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dualmediaspzoo/symfony-request-dto-bundle
A Symfony DTO request bundle to allow easier data input and validation on controllers
https://github.com/dualmediaspzoo/symfony-request-dto-bundle
doctrine php symfony symfony-bundle
Last synced: 3 months ago
JSON representation
A Symfony DTO request bundle to allow easier data input and validation on controllers
- Host: GitHub
- URL: https://github.com/dualmediaspzoo/symfony-request-dto-bundle
- Owner: dualmediaspzoo
- License: mit
- Created: 2022-12-07T13:19:07.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-07-18T07:01:47.000Z (6 months ago)
- Last Synced: 2024-09-29T13:41:05.917Z (3 months ago)
- Topics: doctrine, php, symfony, symfony-bundle
- Language: PHP
- Homepage:
- Size: 229 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
README
# Symfony DTO Bundle
[](https://packagist.org/packages/dualmedia/symfony-request-dto-bundle)
This bundle aims to lower the burden of typechecking, casting, loading entities
and related annoyances of using requests in your api.
Bundle will automatically hook into [Doctrine ORM Bundle](https://github.com/doctrine/DoctrineBundle) and [Nelmio API Docs Bundle](https://github.com/nelmio/NelmioApiDocBundle) so no additional configuration should be needed.
## Install
Simply `composer require dualmedia/symfony-request-dto-bundle`, if applicable your Doctrine entity managers will be detected automatically and used as default providers for classes to be loaded with your requests if needed.
Then add the bundle to your `config/bundles.php` file like so
```php
return [
Symfony\Bundle\FrameworkBundle\FrameworkBundle::class => ['all' => true],
// other bundles ...
DualMedia\DtoRequestBundle\DtoBundle::class => ['all' => true],
];
```
## Upgrades
See [CHANGES.md](CHANGES.md)
## Usage
1. Create a DTO class for your request
```php
use \DualMedia\DtoRequestBundle\Attributes\Dto\Path;
use \DualMedia\DtoRequestBundle\Model\AbstractDto;
class MyDto extends AbstractDto
{
public int|null $myVar = null;
#[Path("custom_path")]
public string|null $myString = null;
}
```
2. Add your dto as a controller argument
```php
class MyController extends \Symfony\Bundle\FrameworkBundle\Controller\AbstractController
{
public function myAction(MyDto $dto): \Symfony\Component\HttpFoundation\Response
{
// your dto here is already validated!
}
}
```
## Application wide handling of DTO issues
If you wish to automatically return a 4XX response code when a dto has failed validation you may use something like the following:
```yaml
# config/services.yaml
App\EventSubscriber\ErrorSubscriber:
decorates: exception_listener
arguments:
- '@App\EventSubscriber\ErrorSubscriber.inner'
```
```php
class ErrorSubscriber implements \Symfony\Component\EventDispatcher\EventSubscriberInterface
{
public function __construct(
private readonly ErrorListener $decorated
) {
}
public static function getSubscribedEvents(){
return [
\Symfony\Component\HttpKernel\Event\ControllerArgumentsEvent::class => 'onControllerArguments',
];
}
public function onControllerArguments(
ControllerArgumentsEvent $event
): void {
$this->decorated->onControllerArguments($event);
$violationList = new ConstraintViolationList();
foreach ($event->getArguments() as $argument) {
if ($argument instanceof DtoInterface
&& !$argument->isOptional()
&& !$argument->isValid()) {
$violationList->addAll($argument->getConstraintViolationList());
}
}
if (0 !== $violationList->count()) {
throw new ValidatorException($violationList); // handle and display, or just do whatever really
}
}
}
```
If you want to map a class-wide assert to a path without having to directly modify the constraint itself you may wrap it in MappedToPath
```php
use \DualMedia\DtoRequestBundle\Constraints\MappedToPath;
use \DualMedia\DtoRequestBundle\Model\AbstractDto;
use Symfony\Component\Validator\Constraints as Assert;
#[MappedToPath(
'property',
new Assert\Expression(
'this.property != null',
message: 'This property cannot be null'
)
)]
class MyDto extends AbstractDto
{
public int|null $property = null;
}
```
## Docs
Currently no documentation is available, but will be added in the future. For the time being see [the DTO models for tests](tests/Fixtures/Model/Dto)