improve dto documentation #2231
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| public string $email; | ||
| } | ||
| ``` | ||
| You can map a DTO Resource directly to a Doctrine Entity using `stateOptions`. This automatically configures the built-in State Providers and Processors to fetch/persist data using the Entity and map it to your Resource (DTO) using the Symfony Object Mapper. |
There was a problem hiding this comment.
Only with Symfony >= 7.3, right? And what about Laravel?
Comment on lines
+56
to
73
| #[Map(transform: [self::class, 'formatPrice'])] | ||
| public string $price; | ||
|
|
||
| /** | ||
| * @implements ProcessorInterface<UserResetPasswordDto, User> | ||
| */ | ||
| final class UserResetPasswordProcessor implements ProcessorInterface | ||
| { | ||
| /** | ||
| * @param UserResetPasswordDto $data | ||
| * | ||
| * @throws NotFoundHttpException | ||
| */ | ||
| public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = []): User | ||
| public static function formatPrice(mixed $price, object $source, ?object $target): int|string | ||
| { | ||
| if ('user@example.com' === $data->email) { | ||
| return new User(email: $data->email, id: 1); | ||
| // Transform Entity (int) to DTO (string with $) | ||
| if ($target instanceof self) { | ||
| return number_format($price / 100, 2).'$'; | ||
| } | ||
|
|
||
| throw new NotFoundHttpException(); | ||
| // Transform DTO (string with $) to Entity (int) | ||
| if ($target instanceof BookEntity) { | ||
| return 100 * (int) str_replace('$', '', $price); | ||
| } | ||
|
|
||
| throw new \LogicException(\sprintf('Unexpected "%s" source.', $source::class)); | ||
| } | ||
| } |
There was a problem hiding this comment.
For me, a DTO it's here to contain data, not to transform data. When I see the code, I'm sure it's possible to transform the data outside the DTO. IMO, the doc should at least mention (in a comment or below) that it's possible (recommended?) to transform the data outside the DTO.
Comment on lines
+244
to
+245
| use App\Dto\DiscountBook; | ||
| use App\State\DiscountBookProcessor; |
There was a problem hiding this comment.
Suggested change
| use App\Dto\DiscountBook; | |
| use App\State\DiscountBookProcessor; | |
| use App\Dto\DiscountBook; | |
| use App\Entity\Book as BookEntity; | |
| use App\State\DiscountBookProcessor; |
| } | ||
|
|
||
| // 3. Execute Domain Logic | ||
| $bookEntity->discount($data->percentage); |
There was a problem hiding this comment.
I don't see the domain logic here. Maybe it's just an example, but if it is, the comment does not represent the code.
IMO, you should add a comment below (// Add your own domain logic) OR a real example like you did into the DTO.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.