v0.2.0 (4/N): make:bridge:resource --with-dto + symfony/validator
Closes the input-validation gap that was the audit's headline finding.
The legacy generated controller's `if (isset($data['title']))…` body
accepted any JSON: empty title slipped through, malformed JSON got
swallowed by `?? []`, wrong types were silently coerced via casts.
The --with-dto flag generates:
- src/Dto/Create<Name>Dto.php — readonly DTO with #[Assert\NotBlank]
on title and #[Assert\Length(max: 255)]
- src/Dto/Update<Name>Dto.php — same DTO with all fields nullable
so PATCH callers send only what changed
- src/Controller/<Name>Controller.php — same shape as the legacy
controller but actions dispatch via #[MapRequestPayload]
Validation failures (missing required field, wrong type, malformed
JSON, oversize string) become RFC 7807 application/problem+json
automatically — Symfony's RequestPayloadValueResolver does the work.
No `if-isset` boilerplate, no silent coercion.
Behaviour:
- --with-dto is opt-in; legacy template still ships unchanged
- audit suggests flipping to default-on once stable; that's a
follow-up
- maker fails loud (composer require hint) if symfony/validator
isn't autoloadable
- skeleton + example/todo composer.json pull symfony/validator so
scaffolded apps work out of the box
Snapshot test exercises both modes (legacy + --with-dto). New
baselines TodoControllerWithDto.php / CreateTodoDto.php /
UpdateTodoDto.php under tests/snapshot/.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -15,6 +15,7 @@ This section tracks work landing on `dev` toward **v0.2.0** (next minor; pre-1.0
|
||||
- **`BridgeBundleInfo` value object** carrying the bundle's name + class FQCN. `HealthController` now constructor-injects this instead of `PublisherInterface` as the deep-load canary, so the readiness probe is no longer coupled to the publisher's contract. `/healthz` response gains a `name` field (`php-qml/bridge`); the `bundle` field now reports `PhpQml\Bridge\BridgeBundle` (was `PhpQml\Bridge\Publisher`).
|
||||
- **`Maker\Support\NameInput`** — shared interactive name prompt. All three `make:bridge:*` makers (`resource`, `command`, `window`) re-implemented the same "prompt, trim, ucfirst, reject empty" closure inline; collapsed into one call site so empty-argument and validation behaviour stay in lockstep.
|
||||
- **`Maker\Support\Naming`** — `camelTo($name, $separator)` helper. Replaces inline `preg_replace('/(?<!^)[A-Z]/', $sep.'$0', $name)` regex copies (BridgeResourceMaker emits `_`-joined route plurals, BridgeCommandMaker emits `-`-joined kebab slugs).
|
||||
- **`make:bridge:resource --with-dto` opt-in.** Generates `Create<Name>Dto` + `Update<Name>Dto` under `src/Dto/` alongside the controller, and the controller dispatches via `#[MapRequestPayload]`. Closes the input-validation gap from the audit: malformed JSON, missing required fields, or `#[Assert\NotBlank]` violations now produce RFC 7807 `application/problem+json` automatically (Symfony's `RequestPayloadValueResolver`) — no more `if (isset($data['title']))` boilerplate, no silent type coercion. Update DTOs use nullable defaults so PATCH callers send only the fields they want changed. Without `--with-dto` the legacy template still ships unchanged. Maker fails loud if `symfony/validator` isn't autoloadable. Skeleton + example/todo composer.json pull `symfony/validator` so scaffolded apps work out of the box. Snapshot test exercises both modes.
|
||||
|
||||
### Changed
|
||||
|
||||
|
||||
@@ -11,6 +11,7 @@
|
||||
"symfony/security-bundle": "^8.0",
|
||||
"symfony/mercure-bundle": "^0.4",
|
||||
"symfony/uid": "^8.0",
|
||||
"symfony/validator": "^8.0",
|
||||
"doctrine/orm": "^3.0",
|
||||
"doctrine/doctrine-bundle": "^3.0",
|
||||
"doctrine/doctrine-migrations-bundle": "^4.0",
|
||||
|
||||
187
examples/todo/symfony/composer.lock
generated
187
examples/todo/symfony/composer.lock
generated
@@ -4,7 +4,7 @@
|
||||
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
|
||||
"This file is @generated automatically"
|
||||
],
|
||||
"content-hash": "50ef8ab49885db8d3709edc1c8e68e05",
|
||||
"content-hash": "d001a6d1e30f94b4b5044262009031fc",
|
||||
"packages": [
|
||||
{
|
||||
"name": "doctrine/collections",
|
||||
@@ -1199,13 +1199,13 @@
|
||||
"dist": {
|
||||
"type": "path",
|
||||
"url": "../../../framework/php",
|
||||
"reference": "68fca95525db2311a08deb931f1b92909b20c450"
|
||||
"reference": "b426d4a8ca67cde4f3bd0471d340e348b1fd4053"
|
||||
},
|
||||
"require": {
|
||||
"doctrine/dbal": "^4.0",
|
||||
"doctrine/doctrine-bundle": "^3.0",
|
||||
"doctrine/orm": "^3.0",
|
||||
"php": "^8.3",
|
||||
"php": "^8.4",
|
||||
"symfony/config": "^8.0",
|
||||
"symfony/console": "^8.0",
|
||||
"symfony/dependency-injection": "^8.0",
|
||||
@@ -1259,7 +1259,7 @@
|
||||
]
|
||||
},
|
||||
"license": [
|
||||
"proprietary"
|
||||
"LGPL-3.0-or-later"
|
||||
],
|
||||
"description": "Symfony bundle bridging PHP applications to a Qt/QML host (part of the php-qml framework).",
|
||||
"transport-options": {
|
||||
@@ -5024,6 +5024,88 @@
|
||||
],
|
||||
"time": "2026-03-30T15:14:47+00:00"
|
||||
},
|
||||
{
|
||||
"name": "symfony/translation-contracts",
|
||||
"version": "v3.6.1",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/symfony/translation-contracts.git",
|
||||
"reference": "65a8bc82080447fae78373aa10f8d13b38338977"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/symfony/translation-contracts/zipball/65a8bc82080447fae78373aa10f8d13b38338977",
|
||||
"reference": "65a8bc82080447fae78373aa10f8d13b38338977",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"php": ">=8.1"
|
||||
},
|
||||
"type": "library",
|
||||
"extra": {
|
||||
"thanks": {
|
||||
"url": "https://github.com/symfony/contracts",
|
||||
"name": "symfony/contracts"
|
||||
},
|
||||
"branch-alias": {
|
||||
"dev-main": "3.6-dev"
|
||||
}
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"Symfony\\Contracts\\Translation\\": ""
|
||||
},
|
||||
"exclude-from-classmap": [
|
||||
"/Test/"
|
||||
]
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"MIT"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Nicolas Grekas",
|
||||
"email": "p@tchwork.com"
|
||||
},
|
||||
{
|
||||
"name": "Symfony Community",
|
||||
"homepage": "https://symfony.com/contributors"
|
||||
}
|
||||
],
|
||||
"description": "Generic abstractions related to translation",
|
||||
"homepage": "https://symfony.com",
|
||||
"keywords": [
|
||||
"abstractions",
|
||||
"contracts",
|
||||
"decoupling",
|
||||
"interfaces",
|
||||
"interoperability",
|
||||
"standards"
|
||||
],
|
||||
"support": {
|
||||
"source": "https://github.com/symfony/translation-contracts/tree/v3.6.1"
|
||||
},
|
||||
"funding": [
|
||||
{
|
||||
"url": "https://symfony.com/sponsor",
|
||||
"type": "custom"
|
||||
},
|
||||
{
|
||||
"url": "https://github.com/fabpot",
|
||||
"type": "github"
|
||||
},
|
||||
{
|
||||
"url": "https://github.com/nicolas-grekas",
|
||||
"type": "github"
|
||||
},
|
||||
{
|
||||
"url": "https://tidelift.com/funding/github/packagist/symfony/symfony",
|
||||
"type": "tidelift"
|
||||
}
|
||||
],
|
||||
"time": "2025-07-15T13:41:35+00:00"
|
||||
},
|
||||
{
|
||||
"name": "symfony/type-info",
|
||||
"version": "v8.0.9",
|
||||
@@ -5184,6 +5266,101 @@
|
||||
],
|
||||
"time": "2026-04-30T16:10:06+00:00"
|
||||
},
|
||||
{
|
||||
"name": "symfony/validator",
|
||||
"version": "v8.0.9",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/symfony/validator.git",
|
||||
"reference": "131dc8322c06595a6c98185787fa756deada20df"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/symfony/validator/zipball/131dc8322c06595a6c98185787fa756deada20df",
|
||||
"reference": "131dc8322c06595a6c98185787fa756deada20df",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"php": ">=8.4",
|
||||
"symfony/polyfill-ctype": "^1.8",
|
||||
"symfony/polyfill-mbstring": "^1.0",
|
||||
"symfony/translation-contracts": "^2.5|^3"
|
||||
},
|
||||
"conflict": {
|
||||
"doctrine/lexer": "<1.1",
|
||||
"symfony/doctrine-bridge": "<7.4",
|
||||
"symfony/expression-language": "<7.4"
|
||||
},
|
||||
"require-dev": {
|
||||
"egulias/email-validator": "^2.1.10|^3|^4",
|
||||
"symfony/cache": "^7.4|^8.0",
|
||||
"symfony/config": "^7.4|^8.0",
|
||||
"symfony/console": "^7.4|^8.0",
|
||||
"symfony/dependency-injection": "^7.4|^8.0",
|
||||
"symfony/expression-language": "^7.4|^8.0",
|
||||
"symfony/finder": "^7.4|^8.0",
|
||||
"symfony/http-client": "^7.4|^8.0",
|
||||
"symfony/http-foundation": "^7.4|^8.0",
|
||||
"symfony/http-kernel": "^7.4|^8.0",
|
||||
"symfony/intl": "^7.4|^8.0",
|
||||
"symfony/mime": "^7.4|^8.0",
|
||||
"symfony/process": "^7.4|^8.0",
|
||||
"symfony/property-access": "^7.4|^8.0",
|
||||
"symfony/property-info": "^7.4|^8.0",
|
||||
"symfony/string": "^7.4|^8.0",
|
||||
"symfony/translation": "^7.4|^8.0",
|
||||
"symfony/type-info": "^7.4|^8.0",
|
||||
"symfony/yaml": "^7.4|^8.0"
|
||||
},
|
||||
"type": "library",
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"Symfony\\Component\\Validator\\": ""
|
||||
},
|
||||
"exclude-from-classmap": [
|
||||
"/Tests/",
|
||||
"/Resources/bin/"
|
||||
]
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"MIT"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Fabien Potencier",
|
||||
"email": "fabien@symfony.com"
|
||||
},
|
||||
{
|
||||
"name": "Symfony Community",
|
||||
"homepage": "https://symfony.com/contributors"
|
||||
}
|
||||
],
|
||||
"description": "Provides tools to validate values",
|
||||
"homepage": "https://symfony.com",
|
||||
"support": {
|
||||
"source": "https://github.com/symfony/validator/tree/v8.0.9"
|
||||
},
|
||||
"funding": [
|
||||
{
|
||||
"url": "https://symfony.com/sponsor",
|
||||
"type": "custom"
|
||||
},
|
||||
{
|
||||
"url": "https://github.com/fabpot",
|
||||
"type": "github"
|
||||
},
|
||||
{
|
||||
"url": "https://github.com/nicolas-grekas",
|
||||
"type": "github"
|
||||
},
|
||||
{
|
||||
"url": "https://tidelift.com/funding/github/packagist/symfony/symfony",
|
||||
"type": "tidelift"
|
||||
}
|
||||
],
|
||||
"time": "2026-04-30T16:10:06+00:00"
|
||||
},
|
||||
{
|
||||
"name": "symfony/var-dumper",
|
||||
"version": "v8.0.8",
|
||||
@@ -5743,7 +5920,7 @@
|
||||
"prefer-stable": false,
|
||||
"prefer-lowest": false,
|
||||
"platform": {
|
||||
"php": "^8.3"
|
||||
"php": "^8.4"
|
||||
},
|
||||
"platform-dev": {},
|
||||
"plugin-api-version": "2.6.0"
|
||||
|
||||
@@ -24,6 +24,7 @@ use Symfony\Component\HttpFoundation\Request;
|
||||
use Symfony\Component\Routing\Attribute\Route;
|
||||
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
|
||||
use Symfony\Component\Uid\Uuid;
|
||||
use Symfony\Component\Validator\Constraints\NotBlank;
|
||||
|
||||
/**
|
||||
* `make:bridge:resource <Name>` — generates the three files needed to
|
||||
@@ -71,11 +72,21 @@ final class BridgeResourceMaker extends AbstractMaker
|
||||
InputOption::VALUE_NONE,
|
||||
'Use auto-incrementing int IDs instead of the default UUIDv7.',
|
||||
)
|
||||
->addOption(
|
||||
'with-dto',
|
||||
null,
|
||||
InputOption::VALUE_NONE,
|
||||
'Generate Create<Name>Dto + Update<Name>Dto alongside the controller and dispatch via #[MapRequestPayload]. Requires symfony/validator.',
|
||||
)
|
||||
->setHelp(
|
||||
"The maker creates three files:\n\n"
|
||||
"The maker creates three files (or five with --with-dto):\n\n"
|
||||
." • <info>src/Entity/Todo.php</info> — Doctrine entity tagged with #[BridgeResource]\n"
|
||||
." • <info>src/Controller/TodoController.php</info> — CRUD on /api/todos\n"
|
||||
." • <info>{qml_path}/TodoList.qml</info> — starter ReactiveListModel snippet\n\n"
|
||||
."With <info>--with-dto</info> the controller dispatches via #[MapRequestPayload]\n"
|
||||
."against generated Create/Update DTOs (validated, no if-isset stubs):\n\n"
|
||||
." • <info>src/Dto/CreateTodoDto.php</info> — POST payload with #[Assert\\NotBlank] etc.\n"
|
||||
." • <info>src/Dto/UpdateTodoDto.php</info> — PATCH payload (all fields nullable)\n\n"
|
||||
."After the maker, run <info>bin/console make:migration</info> and apply it.\n"
|
||||
);
|
||||
}
|
||||
@@ -95,6 +106,13 @@ final class BridgeResourceMaker extends AbstractMaker
|
||||
{
|
||||
$rawName = (string) $input->getArgument('name');
|
||||
$useUuid = !(bool) $input->getOption('int-id');
|
||||
$useDto = (bool) $input->getOption('with-dto');
|
||||
|
||||
if ($useDto && !class_exists(NotBlank::class)) {
|
||||
$io->error('--with-dto requires symfony/validator. Run: composer require symfony/validator');
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
$singular = ucfirst(Str::asCamelCase($rawName));
|
||||
$pluralCamel = Str::singularCamelCaseToPluralCamelCase($singular);
|
||||
@@ -128,9 +146,34 @@ final class BridgeResourceMaker extends AbstractMaker
|
||||
__DIR__.'/templates/Entity.tpl.php',
|
||||
$vars,
|
||||
);
|
||||
|
||||
if ($useDto) {
|
||||
$createDto = $generator->createClassNameDetails(
|
||||
'Create'.$singular,
|
||||
'Dto\\',
|
||||
'Dto',
|
||||
);
|
||||
$updateDto = $generator->createClassNameDetails(
|
||||
'Update'.$singular,
|
||||
'Dto\\',
|
||||
'Dto',
|
||||
);
|
||||
$generator->generateFile(
|
||||
'src/Dto/'.$createDto->getShortName().'.php',
|
||||
__DIR__.'/templates/CreateDto.tpl.php',
|
||||
$vars,
|
||||
);
|
||||
$generator->generateFile(
|
||||
'src/Dto/'.$updateDto->getShortName().'.php',
|
||||
__DIR__.'/templates/UpdateDto.tpl.php',
|
||||
$vars,
|
||||
);
|
||||
}
|
||||
|
||||
$controllerTemplate = $useDto ? 'ControllerWithDto.tpl.php' : 'Controller.tpl.php';
|
||||
$generator->generateFile(
|
||||
'src/Controller/'.$controllerFqcn->getShortName().'.php',
|
||||
__DIR__.'/templates/Controller.tpl.php',
|
||||
__DIR__.'/templates/'.$controllerTemplate,
|
||||
$vars,
|
||||
);
|
||||
|
||||
|
||||
95
framework/php/src/Maker/templates/ControllerWithDto.tpl.php
Normal file
95
framework/php/src/Maker/templates/ControllerWithDto.tpl.php
Normal file
@@ -0,0 +1,95 @@
|
||||
<?= "<?php\n" ?>
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Controller;
|
||||
|
||||
use App\Dto\Create<?= $entity_short ?>Dto;
|
||||
use App\Dto\Update<?= $entity_short ?>Dto;
|
||||
use <?= $entity_fqcn ?>;
|
||||
use Doctrine\ORM\EntityManagerInterface;
|
||||
use Symfony\Component\HttpFoundation\JsonResponse;
|
||||
use Symfony\Component\HttpFoundation\Response;
|
||||
use Symfony\Component\HttpKernel\Attribute\MapRequestPayload;
|
||||
use Symfony\Component\Routing\Attribute\Route;
|
||||
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
|
||||
|
||||
/**
|
||||
* Auto-generated CRUD controller for the <?= $singular ?> bridge resource (DTO-shaped).
|
||||
* Edit freely — re-running make:bridge:resource won't overwrite this file.
|
||||
*
|
||||
* Validated input via #[MapRequestPayload]: malformed JSON, missing
|
||||
* required fields, or constraint violations produce RFC 7807
|
||||
* problem+json automatically (Symfony's RequestPayloadValueResolver).
|
||||
*/
|
||||
#[Route('<?= $route ?>')]
|
||||
final class <?= $entity_short ?>Controller
|
||||
{
|
||||
public function __construct(
|
||||
private readonly EntityManagerInterface $em,
|
||||
private readonly NormalizerInterface $normalizer,
|
||||
) {
|
||||
}
|
||||
|
||||
#[Route('', name: '<?= $resource ?>_list', methods: ['GET'])]
|
||||
public function list(): JsonResponse
|
||||
{
|
||||
$items = $this->em->getRepository(<?= $entity_short ?>::class)->findAll();
|
||||
|
||||
return new JsonResponse($this->normalizer->normalize($items, 'json'));
|
||||
}
|
||||
|
||||
#[Route('', name: '<?= $resource ?>_create', methods: ['POST'])]
|
||||
public function create(#[MapRequestPayload] Create<?= $entity_short ?>Dto $dto): JsonResponse
|
||||
{
|
||||
$entity = new <?= $entity_short ?>();
|
||||
$entity->setTitle($dto->title);
|
||||
$entity->setDone($dto->done);
|
||||
|
||||
$this->em->persist($entity);
|
||||
$this->em->flush();
|
||||
|
||||
return new JsonResponse(
|
||||
$this->normalizer->normalize($entity, 'json'),
|
||||
Response::HTTP_CREATED,
|
||||
);
|
||||
}
|
||||
|
||||
#[Route('/{id}', name: '<?= $resource ?>_update', methods: ['PATCH'])]
|
||||
public function update(string $id, #[MapRequestPayload] Update<?= $entity_short ?>Dto $dto): JsonResponse
|
||||
{
|
||||
$entity = $this->em->getRepository(<?= $entity_short ?>::class)->find($id);
|
||||
if (null === $entity) {
|
||||
return new JsonResponse(
|
||||
['title' => 'Not Found', 'status' => 404],
|
||||
Response::HTTP_NOT_FOUND,
|
||||
['Content-Type' => 'application/problem+json'],
|
||||
);
|
||||
}
|
||||
|
||||
if (null !== $dto->title) {
|
||||
$entity->setTitle($dto->title);
|
||||
}
|
||||
if (null !== $dto->done) {
|
||||
$entity->setDone($dto->done);
|
||||
}
|
||||
|
||||
$this->em->flush();
|
||||
|
||||
return new JsonResponse($this->normalizer->normalize($entity, 'json'));
|
||||
}
|
||||
|
||||
#[Route('/{id}', name: '<?= $resource ?>_delete', methods: ['DELETE'])]
|
||||
public function delete(string $id): JsonResponse
|
||||
{
|
||||
$entity = $this->em->getRepository(<?= $entity_short ?>::class)->find($id);
|
||||
if (null === $entity) {
|
||||
return new JsonResponse(null, Response::HTTP_NO_CONTENT);
|
||||
}
|
||||
|
||||
$this->em->remove($entity);
|
||||
$this->em->flush();
|
||||
|
||||
return new JsonResponse(null, Response::HTTP_NO_CONTENT);
|
||||
}
|
||||
}
|
||||
26
framework/php/src/Maker/templates/CreateDto.tpl.php
Normal file
26
framework/php/src/Maker/templates/CreateDto.tpl.php
Normal file
@@ -0,0 +1,26 @@
|
||||
<?= "<?php\n" ?>
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Dto;
|
||||
|
||||
use Symfony\Component\Validator\Constraints as Assert;
|
||||
|
||||
/**
|
||||
* Validated payload for POST <?= $route ?>.
|
||||
*
|
||||
* Auto-generated alongside <?= $entity_short ?>Controller's create() action.
|
||||
* #[MapRequestPayload] in the controller turns malformed JSON or any
|
||||
* Assert violation here into an RFC 7807 problem+json response — no
|
||||
* controller-level if-isset boilerplate, no silent type coercion.
|
||||
*/
|
||||
final readonly class Create<?= $entity_short ?>Dto
|
||||
{
|
||||
public function __construct(
|
||||
#[Assert\NotBlank]
|
||||
#[Assert\Length(max: 255)]
|
||||
public string $title,
|
||||
public bool $done = false,
|
||||
) {
|
||||
}
|
||||
}
|
||||
24
framework/php/src/Maker/templates/UpdateDto.tpl.php
Normal file
24
framework/php/src/Maker/templates/UpdateDto.tpl.php
Normal file
@@ -0,0 +1,24 @@
|
||||
<?= "<?php\n" ?>
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Dto;
|
||||
|
||||
use Symfony\Component\Validator\Constraints as Assert;
|
||||
|
||||
/**
|
||||
* Validated payload for PATCH <?= $route ?>/{id}.
|
||||
*
|
||||
* All fields are nullable so PATCH callers can send only the fields
|
||||
* they want to change. The controller checks each for null and
|
||||
* skips the corresponding entity setter.
|
||||
*/
|
||||
final readonly class Update<?= $entity_short ?>Dto
|
||||
{
|
||||
public function __construct(
|
||||
#[Assert\Length(max: 255)]
|
||||
public ?string $title = null,
|
||||
public ?bool $done = null,
|
||||
) {
|
||||
}
|
||||
}
|
||||
26
framework/php/tests/snapshot/CreateTodoDto.php
Normal file
26
framework/php/tests/snapshot/CreateTodoDto.php
Normal file
@@ -0,0 +1,26 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Dto;
|
||||
|
||||
use Symfony\Component\Validator\Constraints as Assert;
|
||||
|
||||
/**
|
||||
* Validated payload for POST /api/todos.
|
||||
*
|
||||
* Auto-generated alongside TodoController's create() action.
|
||||
* #[MapRequestPayload] in the controller turns malformed JSON or any
|
||||
* Assert violation here into an RFC 7807 problem+json response — no
|
||||
* controller-level if-isset boilerplate, no silent type coercion.
|
||||
*/
|
||||
final readonly class CreateTodoDto
|
||||
{
|
||||
public function __construct(
|
||||
#[Assert\NotBlank]
|
||||
#[Assert\Length(max: 255)]
|
||||
public string $title,
|
||||
public bool $done = false,
|
||||
) {
|
||||
}
|
||||
}
|
||||
98
framework/php/tests/snapshot/TodoControllerWithDto.php
Normal file
98
framework/php/tests/snapshot/TodoControllerWithDto.php
Normal file
@@ -0,0 +1,98 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Controller;
|
||||
|
||||
use App\Dto\CreateTodoDto;
|
||||
use App\Dto\UpdateTodoDto;
|
||||
use App\Entity\Todo;
|
||||
use Doctrine\ORM\EntityManagerInterface;
|
||||
use Symfony\Component\HttpFoundation\JsonResponse;
|
||||
use Symfony\Component\HttpFoundation\Response;
|
||||
use Symfony\Component\HttpKernel\Attribute\MapRequestPayload;
|
||||
use Symfony\Component\Routing\Attribute\Route;
|
||||
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
|
||||
|
||||
/**
|
||||
* Auto-generated CRUD controller for the Todo bridge resource (DTO-shaped).
|
||||
* Edit freely — re-running make:bridge:resource won't overwrite this file.
|
||||
*
|
||||
* Validated input via #[MapRequestPayload]: malformed JSON, missing
|
||||
* required fields, or constraint violations produce RFC 7807
|
||||
* problem+json automatically (Symfony's RequestPayloadValueResolver).
|
||||
*/
|
||||
#[Route('/api/todos')]
|
||||
final class TodoController
|
||||
{
|
||||
public function __construct(
|
||||
private readonly EntityManagerInterface $em,
|
||||
private readonly NormalizerInterface $normalizer,
|
||||
) {
|
||||
}
|
||||
|
||||
#[Route('', name: 'todo_list', methods: ['GET'])]
|
||||
public function list(): JsonResponse
|
||||
{
|
||||
$items = $this->em->getRepository(Todo::class)->findAll();
|
||||
|
||||
return new JsonResponse($this->normalizer->normalize($items, 'json'));
|
||||
}
|
||||
|
||||
#[Route('', name: 'todo_create', methods: ['POST'])]
|
||||
public function create(#[MapRequestPayload] CreateTodoDto $dto): JsonResponse
|
||||
{
|
||||
$entity = new Todo();
|
||||
$entity->setTitle($dto->title);
|
||||
$entity->setDone($dto->done);
|
||||
|
||||
$this->em->persist($entity);
|
||||
$this->em->flush();
|
||||
|
||||
return new JsonResponse(
|
||||
$this->normalizer->normalize($entity, 'json'),
|
||||
Response::HTTP_CREATED,
|
||||
);
|
||||
}
|
||||
|
||||
#[Route('/{id}', name: 'todo_update', methods: ['PATCH'])]
|
||||
public function update(string $id, #[MapRequestPayload] UpdateTodoDto $dto): JsonResponse
|
||||
{
|
||||
$entity = $this->em->getRepository(Todo::class)->find($id);
|
||||
|
||||
if (null === $entity) {
|
||||
return new JsonResponse(
|
||||
['title' => 'Not Found', 'status' => 404],
|
||||
Response::HTTP_NOT_FOUND,
|
||||
['Content-Type' => 'application/problem+json'],
|
||||
);
|
||||
}
|
||||
|
||||
if (null !== $dto->title) {
|
||||
$entity->setTitle($dto->title);
|
||||
}
|
||||
|
||||
if (null !== $dto->done) {
|
||||
$entity->setDone($dto->done);
|
||||
}
|
||||
|
||||
$this->em->flush();
|
||||
|
||||
return new JsonResponse($this->normalizer->normalize($entity, 'json'));
|
||||
}
|
||||
|
||||
#[Route('/{id}', name: 'todo_delete', methods: ['DELETE'])]
|
||||
public function delete(string $id): JsonResponse
|
||||
{
|
||||
$entity = $this->em->getRepository(Todo::class)->find($id);
|
||||
|
||||
if (null === $entity) {
|
||||
return new JsonResponse(null, Response::HTTP_NO_CONTENT);
|
||||
}
|
||||
|
||||
$this->em->remove($entity);
|
||||
$this->em->flush();
|
||||
|
||||
return new JsonResponse(null, Response::HTTP_NO_CONTENT);
|
||||
}
|
||||
}
|
||||
24
framework/php/tests/snapshot/UpdateTodoDto.php
Normal file
24
framework/php/tests/snapshot/UpdateTodoDto.php
Normal file
@@ -0,0 +1,24 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Dto;
|
||||
|
||||
use Symfony\Component\Validator\Constraints as Assert;
|
||||
|
||||
/**
|
||||
* Validated payload for PATCH /api/todos/{id}.
|
||||
*
|
||||
* All fields are nullable so PATCH callers can send only the fields
|
||||
* they want to change. The controller checks each for null and
|
||||
* skips the corresponding entity setter.
|
||||
*/
|
||||
final readonly class UpdateTodoDto
|
||||
{
|
||||
public function __construct(
|
||||
#[Assert\Length(max: 255)]
|
||||
public ?string $title = null,
|
||||
public ?bool $done = null,
|
||||
) {
|
||||
}
|
||||
}
|
||||
@@ -24,18 +24,6 @@ sed -i "s|\"../../php\"|\"$BUNDLE\"|" "$APP/symfony/composer.json"
|
||||
rm -f "$APP/symfony/composer.lock"
|
||||
( cd "$APP/symfony" && composer install --no-interaction --quiet )
|
||||
|
||||
# Remove the existing maker outputs so the regenerators don't bail.
|
||||
rm -f "$APP/symfony/src/Entity/Todo.php"
|
||||
rm -f "$APP/symfony/src/Controller/TodoController.php"
|
||||
rm -f "$APP/qml/TodoList.qml"
|
||||
|
||||
# Run every maker we cover.
|
||||
( cd "$APP/symfony" \
|
||||
&& bin/console make:bridge:resource Todo --no-interaction >/dev/null \
|
||||
&& bin/console make:bridge:command MarkAllDone --no-interaction >/dev/null \
|
||||
&& bin/console make:bridge:window Todo --no-interaction >/dev/null )
|
||||
|
||||
# Compare each generated file to its snapshot baseline.
|
||||
fail=0
|
||||
check() {
|
||||
local generated="$1"
|
||||
@@ -49,15 +37,42 @@ check() {
|
||||
fi
|
||||
}
|
||||
|
||||
clear_outputs() {
|
||||
rm -f "$APP/symfony/src/Entity/Todo.php"
|
||||
rm -f "$APP/symfony/src/Controller/TodoController.php"
|
||||
rm -f "$APP/symfony/src/Dto/CreateTodoDto.php"
|
||||
rm -f "$APP/symfony/src/Dto/UpdateTodoDto.php"
|
||||
rm -f "$APP/qml/TodoList.qml"
|
||||
}
|
||||
|
||||
# ── Mode 1: legacy (no --with-dto) ────────────────────────────────────
|
||||
clear_outputs
|
||||
( cd "$APP/symfony" \
|
||||
&& bin/console make:bridge:resource Todo --no-interaction >/dev/null \
|
||||
&& bin/console make:bridge:command MarkAllDone --no-interaction >/dev/null \
|
||||
&& bin/console make:bridge:window Todo --no-interaction >/dev/null )
|
||||
|
||||
check "$APP/symfony/src/Entity/Todo.php" "$SCRIPT_DIR/Todo.php"
|
||||
check "$APP/symfony/src/Controller/TodoController.php" "$SCRIPT_DIR/TodoController.php"
|
||||
check "$APP/qml/TodoList.qml" "$SCRIPT_DIR/TodoList.qml"
|
||||
check "$APP/symfony/src/Controller/MarkAllDoneController.php" "$SCRIPT_DIR/MarkAllDoneController.php"
|
||||
check "$APP/qml/TodoWindow.qml" "$SCRIPT_DIR/TodoWindow.qml"
|
||||
|
||||
# ── Mode 2: --with-dto (re-runs make:bridge:resource only) ────────────
|
||||
# The entity + QML output is byte-identical between modes; only the
|
||||
# controller swaps and the two DTOs appear. Re-checking the unchanged
|
||||
# outputs would just be noise.
|
||||
clear_outputs
|
||||
( cd "$APP/symfony" \
|
||||
&& bin/console make:bridge:resource Todo --with-dto --no-interaction >/dev/null )
|
||||
|
||||
check "$APP/symfony/src/Controller/TodoController.php" "$SCRIPT_DIR/TodoControllerWithDto.php"
|
||||
check "$APP/symfony/src/Dto/CreateTodoDto.php" "$SCRIPT_DIR/CreateTodoDto.php"
|
||||
check "$APP/symfony/src/Dto/UpdateTodoDto.php" "$SCRIPT_DIR/UpdateTodoDto.php"
|
||||
|
||||
if [ "$fail" -ne 0 ]; then
|
||||
echo "Snapshot test failed. If the change is intended, update the baselines under $SCRIPT_DIR/." >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "All maker outputs match snapshots."
|
||||
echo "All maker outputs match snapshots (legacy + --with-dto modes)."
|
||||
|
||||
@@ -11,6 +11,7 @@
|
||||
"symfony/security-bundle": "^8.0",
|
||||
"symfony/mercure-bundle": "^0.4",
|
||||
"symfony/uid": "^8.0",
|
||||
"symfony/validator": "^8.0",
|
||||
"doctrine/orm": "^3.0",
|
||||
"doctrine/doctrine-bundle": "^3.0",
|
||||
"doctrine/doctrine-migrations-bundle": "^4.0",
|
||||
|
||||
187
framework/skeleton/symfony/composer.lock
generated
187
framework/skeleton/symfony/composer.lock
generated
@@ -4,7 +4,7 @@
|
||||
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
|
||||
"This file is @generated automatically"
|
||||
],
|
||||
"content-hash": "dd53e6e42aa4773eaed84e9eaa374a68",
|
||||
"content-hash": "c339068ebced1f2d3b2ce954e79f5ea6",
|
||||
"packages": [
|
||||
{
|
||||
"name": "doctrine/collections",
|
||||
@@ -1199,13 +1199,13 @@
|
||||
"dist": {
|
||||
"type": "path",
|
||||
"url": "../../php",
|
||||
"reference": "68fca95525db2311a08deb931f1b92909b20c450"
|
||||
"reference": "b426d4a8ca67cde4f3bd0471d340e348b1fd4053"
|
||||
},
|
||||
"require": {
|
||||
"doctrine/dbal": "^4.0",
|
||||
"doctrine/doctrine-bundle": "^3.0",
|
||||
"doctrine/orm": "^3.0",
|
||||
"php": "^8.3",
|
||||
"php": "^8.4",
|
||||
"symfony/config": "^8.0",
|
||||
"symfony/console": "^8.0",
|
||||
"symfony/dependency-injection": "^8.0",
|
||||
@@ -1259,7 +1259,7 @@
|
||||
]
|
||||
},
|
||||
"license": [
|
||||
"proprietary"
|
||||
"LGPL-3.0-or-later"
|
||||
],
|
||||
"description": "Symfony bundle bridging PHP applications to a Qt/QML host (part of the php-qml framework).",
|
||||
"transport-options": {
|
||||
@@ -5024,6 +5024,88 @@
|
||||
],
|
||||
"time": "2026-03-30T15:14:47+00:00"
|
||||
},
|
||||
{
|
||||
"name": "symfony/translation-contracts",
|
||||
"version": "v3.6.1",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/symfony/translation-contracts.git",
|
||||
"reference": "65a8bc82080447fae78373aa10f8d13b38338977"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/symfony/translation-contracts/zipball/65a8bc82080447fae78373aa10f8d13b38338977",
|
||||
"reference": "65a8bc82080447fae78373aa10f8d13b38338977",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"php": ">=8.1"
|
||||
},
|
||||
"type": "library",
|
||||
"extra": {
|
||||
"thanks": {
|
||||
"url": "https://github.com/symfony/contracts",
|
||||
"name": "symfony/contracts"
|
||||
},
|
||||
"branch-alias": {
|
||||
"dev-main": "3.6-dev"
|
||||
}
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"Symfony\\Contracts\\Translation\\": ""
|
||||
},
|
||||
"exclude-from-classmap": [
|
||||
"/Test/"
|
||||
]
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"MIT"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Nicolas Grekas",
|
||||
"email": "p@tchwork.com"
|
||||
},
|
||||
{
|
||||
"name": "Symfony Community",
|
||||
"homepage": "https://symfony.com/contributors"
|
||||
}
|
||||
],
|
||||
"description": "Generic abstractions related to translation",
|
||||
"homepage": "https://symfony.com",
|
||||
"keywords": [
|
||||
"abstractions",
|
||||
"contracts",
|
||||
"decoupling",
|
||||
"interfaces",
|
||||
"interoperability",
|
||||
"standards"
|
||||
],
|
||||
"support": {
|
||||
"source": "https://github.com/symfony/translation-contracts/tree/v3.6.1"
|
||||
},
|
||||
"funding": [
|
||||
{
|
||||
"url": "https://symfony.com/sponsor",
|
||||
"type": "custom"
|
||||
},
|
||||
{
|
||||
"url": "https://github.com/fabpot",
|
||||
"type": "github"
|
||||
},
|
||||
{
|
||||
"url": "https://github.com/nicolas-grekas",
|
||||
"type": "github"
|
||||
},
|
||||
{
|
||||
"url": "https://tidelift.com/funding/github/packagist/symfony/symfony",
|
||||
"type": "tidelift"
|
||||
}
|
||||
],
|
||||
"time": "2025-07-15T13:41:35+00:00"
|
||||
},
|
||||
{
|
||||
"name": "symfony/type-info",
|
||||
"version": "v8.0.9",
|
||||
@@ -5184,6 +5266,101 @@
|
||||
],
|
||||
"time": "2026-04-30T16:10:06+00:00"
|
||||
},
|
||||
{
|
||||
"name": "symfony/validator",
|
||||
"version": "v8.0.9",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/symfony/validator.git",
|
||||
"reference": "131dc8322c06595a6c98185787fa756deada20df"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/symfony/validator/zipball/131dc8322c06595a6c98185787fa756deada20df",
|
||||
"reference": "131dc8322c06595a6c98185787fa756deada20df",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"php": ">=8.4",
|
||||
"symfony/polyfill-ctype": "^1.8",
|
||||
"symfony/polyfill-mbstring": "^1.0",
|
||||
"symfony/translation-contracts": "^2.5|^3"
|
||||
},
|
||||
"conflict": {
|
||||
"doctrine/lexer": "<1.1",
|
||||
"symfony/doctrine-bridge": "<7.4",
|
||||
"symfony/expression-language": "<7.4"
|
||||
},
|
||||
"require-dev": {
|
||||
"egulias/email-validator": "^2.1.10|^3|^4",
|
||||
"symfony/cache": "^7.4|^8.0",
|
||||
"symfony/config": "^7.4|^8.0",
|
||||
"symfony/console": "^7.4|^8.0",
|
||||
"symfony/dependency-injection": "^7.4|^8.0",
|
||||
"symfony/expression-language": "^7.4|^8.0",
|
||||
"symfony/finder": "^7.4|^8.0",
|
||||
"symfony/http-client": "^7.4|^8.0",
|
||||
"symfony/http-foundation": "^7.4|^8.0",
|
||||
"symfony/http-kernel": "^7.4|^8.0",
|
||||
"symfony/intl": "^7.4|^8.0",
|
||||
"symfony/mime": "^7.4|^8.0",
|
||||
"symfony/process": "^7.4|^8.0",
|
||||
"symfony/property-access": "^7.4|^8.0",
|
||||
"symfony/property-info": "^7.4|^8.0",
|
||||
"symfony/string": "^7.4|^8.0",
|
||||
"symfony/translation": "^7.4|^8.0",
|
||||
"symfony/type-info": "^7.4|^8.0",
|
||||
"symfony/yaml": "^7.4|^8.0"
|
||||
},
|
||||
"type": "library",
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"Symfony\\Component\\Validator\\": ""
|
||||
},
|
||||
"exclude-from-classmap": [
|
||||
"/Tests/",
|
||||
"/Resources/bin/"
|
||||
]
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"MIT"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Fabien Potencier",
|
||||
"email": "fabien@symfony.com"
|
||||
},
|
||||
{
|
||||
"name": "Symfony Community",
|
||||
"homepage": "https://symfony.com/contributors"
|
||||
}
|
||||
],
|
||||
"description": "Provides tools to validate values",
|
||||
"homepage": "https://symfony.com",
|
||||
"support": {
|
||||
"source": "https://github.com/symfony/validator/tree/v8.0.9"
|
||||
},
|
||||
"funding": [
|
||||
{
|
||||
"url": "https://symfony.com/sponsor",
|
||||
"type": "custom"
|
||||
},
|
||||
{
|
||||
"url": "https://github.com/fabpot",
|
||||
"type": "github"
|
||||
},
|
||||
{
|
||||
"url": "https://github.com/nicolas-grekas",
|
||||
"type": "github"
|
||||
},
|
||||
{
|
||||
"url": "https://tidelift.com/funding/github/packagist/symfony/symfony",
|
||||
"type": "tidelift"
|
||||
}
|
||||
],
|
||||
"time": "2026-04-30T16:10:06+00:00"
|
||||
},
|
||||
{
|
||||
"name": "symfony/var-dumper",
|
||||
"version": "v8.0.8",
|
||||
@@ -5743,7 +5920,7 @@
|
||||
"prefer-stable": false,
|
||||
"prefer-lowest": false,
|
||||
"platform": {
|
||||
"php": "^8.3"
|
||||
"php": "^8.4"
|
||||
},
|
||||
"platform-dev": {},
|
||||
"plugin-api-version": "2.6.0"
|
||||
|
||||
Reference in New Issue
Block a user