[LiveComponent] Add support for interfaces while (de)hydrating a Doctrine entity #2834
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
…iased to an entity Doctrine have the feature to use interface aliased to a concrete entity class. This PR propose a small modification to ensure that is will also supported by the doctrine hydrator
Kocal
changed the title
Kocal
requested changes
Jun 12, 2025
src/LiveComponent/src/Hydration/DoctrineEntityHydrationExtension.php
Outdated
Show resolved
Hide resolved
src/LiveComponent/src/Hydration/DoctrineEntityHydrationExtension.php
Outdated
Show resolved
Hide resolved
src/LiveComponent/src/Hydration/DoctrineEntityHydrationExtension.php
Outdated
Show resolved
Hide resolved
carsonbot
added
Status: Needs Work
Making tests
carsonbot
added
Status: Needs Review
|
The last commit provides some tests. |
smnandre
reviewed
Jun 26, 2025
smnandre
reviewed
Aug 10, 2025
Comment on lines
+175
to
+176
| 'resolve_target_entities' => [ | ||
| AliasedEntityInterface::class => AliasedEntity::class], |
There was a problem hiding this comment.
Suggested change
| 'resolve_target_entities' => [ | |
| AliasedEntityInterface::class => AliasedEntity::class], | |
| 'resolve_target_entities' => [ | |
| AliasedEntityInterface::class => AliasedEntity::class, | |
| ], |
smnandre
reviewed
Aug 10, 2025
| @@ -50,4 +53,34 @@ public function testForeignKeyId(): void | |||
| self::assertSame($foreignKeyIdEntity->id->id, $dehydrated); | |||
| self::assertSame($foreignKeyIdEntity, $extension->hydrate($dehydrated, ForeignKeyIdEntity::class)); | |||
| } | |||
|
|
|||
| public function testSupportInterface(): void | |||
There was a problem hiding this comment.
Suggested change
| public function testSupportInterface(): void | |
| public function testSupportInterface() |
smnandre
reviewed
Aug 10, 2025
| self::assertFalse($extension->supports('UnknownClass'), 'UnknownClass should not be supported'); | ||
| } | ||
|
|
||
| public function testHydrationFromInterface(): void |
There was a problem hiding this comment.
Suggested change
| public function testHydrationFromInterface(): void | |
| public function testHydrationFromInterface() |
smnandre
reviewed
Aug 10, 2025
| namespace Symfony\UX\LiveComponent\Tests\Fixtures\Entity; | ||
|
|
||
| interface AliasedEntityInterface { | ||
|
|
smnandre
reviewed
Aug 10, 2025
|
|
||
| class Aliased | ||
| { | ||
| // public string $address; |
There was a problem hiding this comment.
Suggested change
| // public string $address; |
smnandre
reviewed
Aug 10, 2025
Comment on lines
+85
to
+86
| // Keep the standard way for a class | ||
| // todo cache/warmup an array of classes that are "doctrine objects" |
There was a problem hiding this comment.
Suggested change
| // Keep the standard way for a class | |
| // todo cache/warmup an array of classes that are "doctrine objects" |
smnandre
reviewed
Aug 10, 2025
| foreach ($this->managerRegistries as $registry) { | ||
| foreach ($registry->getManagers() as $om) { | ||
| // the getClassMetaData can indeed throw an exception | ||
| // so, we |
smnandre
reviewed
Aug 10, 2025
Comment on lines
+114
to
+119
| } catch (MappingException $e) { | ||
| // I did not find a nice way to check if it is because the class is really unknown | ||
| // It is good to check for a specific exception ? | ||
| // eg: \Doctrine\Persistence\Mapping\MappingException | ||
| // @see \Doctrine\Persistence\Mapping\AbstractClassMetadataFactory::getMetadataFor | ||
| // throw $e; |
There was a problem hiding this comment.
We 100% can catch a specific exception if that allows another object manager to be selected during following iterations of the loop(s).
smnandre
reviewed
Aug 10, 2025
| // Fore more details : | ||
| // @see \Doctrine\ORM\Tools\ResolveTargetEntityListener | ||
|
|
||
| // todo cache/warmup an array of interfaces that are resolved "doctrine objects" |
There was a problem hiding this comment.
Suggested change
| // todo cache/warmup an array of interfaces that are resolved "doctrine objects" |
smnandre
reviewed
Aug 10, 2025
Comment on lines
+97
to
+102
| // special handler for interfaces | ||
| // For use cases : @see https://symfony.com/doc/current/doctrine/resolve_target_entity.html | ||
| // As today, getManagerForClass don't resolve nicely aliased interfaces | ||
| // The workaround is to enum over each object manager and trying to get metadata | ||
| // The metadata are indeed, resolved nicely | ||
| // Fore more details : |
There was a problem hiding this comment.
Can we turn this into two or three lines, insisting more on what we "do" than on what "was" the problem ?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Doctrine have the feature to use interface aliased to a concrete entity class.
This PR propose a small modification to ensure that is will also supported by the doctrine hydrator