feat(doctrine): register doctrine provider

Author: joelwurtz

src/AutoMapper.php

@@ -12,13 +12,15 @@
 use AutoMapper\Loader\FileLoader;
 use AutoMapper\Metadata\MetadataFactory;
 use AutoMapper\Metadata\MetadataRegistry;
+use AutoMapper\Provider\Doctrine\DoctrineProvider;
 use AutoMapper\Provider\ProviderInterface;
 use AutoMapper\Provider\ProviderRegistry;
 use AutoMapper\Symfony\ExpressionLanguageProvider;
 use AutoMapper\Transformer\PropertyTransformer\PropertyTransformerInterface;
 use AutoMapper\Transformer\PropertyTransformer\PropertyTransformerRegistry;
 use AutoMapper\Transformer\TransformerFactoryInterface;
 use Doctrine\Common\Annotations\AnnotationReader;
+use Doctrine\ORM\EntityManagerInterface;
 use Symfony\Component\EventDispatcher\EventDispatcher;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
@@ -147,6 +149,7 @@ public static function create(
         ?ExpressionLanguageProvider $expressionLanguageProvider = null,
         EventDispatcherInterface $eventDispatcher = new EventDispatcher(),
         iterable $providers = [],
+        ?EntityManagerInterface $entityManager = null,
     ): AutoMapperInterface {
         if (\count($transformerFactories) > 0) {
             trigger_deprecation('jolicode/automapper', '9.0', 'The "$transformerFactories" property will be removed in version 10.0, AST transformer factories must be included within AutoMapper.', __METHOD__);
@@ -175,6 +178,12 @@ public static function create(
             $classDiscriminatorFromClassMetadata = new ClassDiscriminatorFromClassMetadata($classMetadataFactory);
         }
 
+        $providers = iterator_to_array($providers);
+
+        if (null !== $entityManager) {
+            $providers[] = new DoctrineProvider($entityManager);
+        }
+
         $customTransformerRegistry = new PropertyTransformerRegistry($propertyTransformers);
         $metadataRegistry = new MetadataRegistry($configuration);
         $providerRegistry = new ProviderRegistry($providers);
@@ -189,7 +198,8 @@ public static function create(
             $classMetadataFactory,
             $nameConverter,
             $expressionLanguage,
-            $eventDispatcher
+            $eventDispatcher,
+            $entityManager,
         );
 
         $mapperGenerator = new MapperGenerator(

src/EventListener/Doctrine/DoctrineProviderListener.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AutoMapper\EventListener\Doctrine;
+
+use AutoMapper\Event\GenerateMapperEvent;
+use AutoMapper\Provider\Doctrine\DoctrineProvider;
+use Doctrine\ORM\EntityManagerInterface;
+
+final readonly class DoctrineProviderListener
+{
+    public function __construct(
+        private EntityManagerInterface $entityManager
+    ) {
+    }
+
+    public function __invoke(GenerateMapperEvent $event): void
+    {
+        if (!$this->entityManager->getMetadataFactory()->hasMetadataFor($event->mapperMetadata->target)) {
+            return;
+        }
+
+        $event->provider = DoctrineProvider::class;
+    }
+}

src/Metadata/MetadataFactory.php

@@ -9,6 +9,7 @@
 use AutoMapper\Event\PropertyMetadataEvent;
 use AutoMapper\Event\SourcePropertyMetadata as SourcePropertyMetadataEvent;
 use AutoMapper\Event\TargetPropertyMetadata as TargetPropertyMetadataEvent;
+use AutoMapper\EventListener\Doctrine\DoctrineProviderListener;
 use AutoMapper\EventListener\MapFromListener;
 use AutoMapper\EventListener\MapperListener;
 use AutoMapper\EventListener\MapProviderListener;
@@ -44,6 +45,7 @@
 use AutoMapper\Transformer\TransformerFactoryInterface;
 use AutoMapper\Transformer\UniqueTypeTransformerFactory;
 use AutoMapper\Transformer\VoidTransformer;
+use Doctrine\ORM\EntityManagerInterface;
 use Symfony\Component\EventDispatcher\EventDispatcher;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
@@ -340,6 +342,7 @@ public static function create(
         AdvancedNameConverterInterface|NameConverterInterface|null $nameConverter = null,
         ExpressionLanguage $expressionLanguage = new ExpressionLanguage(),
         EventDispatcherInterface $eventDispatcher = new EventDispatcher(),
+        EntityManagerInterface|null $entityManager = null,
     ): self {
         // Create property info extractors
         $flags = ReflectionExtractor::ALLOW_PUBLIC;
@@ -361,6 +364,10 @@ public static function create(
             $eventDispatcher->addListener(PropertyMetadataEvent::class, new AdvancedNameConverterListener($nameConverter));
         }
 
+        if (null !== $entityManager) {
+            $eventDispatcher->addListener(GenerateMapperEvent::class, new DoctrineProviderListener($entityManager));
+        }
+
         $eventDispatcher->addListener(PropertyMetadataEvent::class, new MapToContextListener($reflectionExtractor));
         $eventDispatcher->addListener(GenerateMapperEvent::class, new MapToListener($customTransformerRegistry, $expressionLanguage));
         $eventDispatcher->addListener(GenerateMapperEvent::class, new MapFromListener($customTransformerRegistry, $expressionLanguage));

src/Provider/Doctrine/DoctrineProvider.php

@@ -1,28 +1,33 @@
 <?php
 
+declare(strict_types=1);
+
 namespace AutoMapper\Provider\Doctrine;
 
 use AutoMapper\Provider\ProviderInterface;
 use Doctrine\ORM\EntityManagerInterface;
 
 final readonly class DoctrineProvider implements ProviderInterface
 {
-    public function __construct(private EntityManagerInterface $entityManager)
-    {
+    public function __construct(
+        private EntityManagerInterface $entityManager
+    ) {
     }
 
     public function provide(string $targetType, mixed $source, array $context): object|array|null
     {
         $metadata = $this->entityManager->getClassMetadata($targetType);
-        $entity = $metadata->identifier;
+        // @TODO support multiple identifiers
+        $identifier = $metadata->identifier;
 
-        $this->entityManager->createQueryBuilder()
+        $result = $this->entityManager->createQueryBuilder()
             ->select('e')
             ->from($targetType, 'e')
-            ->where('e.' . $entity . ' = :id')
-            ->setParameter('id', $source)
+            ->where('e.' . $identifier[0] . ' = :id')
+            ->setParameter('id', $source[$identifier[0]])
             ->getQuery()
             ->getOneOrNullResult();
 
+        return $result;
     }
-}
+}

tests/AutoMapperBuilder.php

@@ -8,6 +8,7 @@
 use AutoMapper\Configuration;
 use AutoMapper\ConstructorStrategy;
 use AutoMapper\Symfony\ExpressionLanguageProvider;
+use Doctrine\ORM\EntityManagerInterface;
 use Symfony\Component\EventDispatcher\EventDispatcher;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\Filesystem\Filesystem;
@@ -28,6 +29,7 @@ public static function buildAutoMapper(
         string $dateTimeFormat = \DateTimeInterface::RFC3339,
         ?ExpressionLanguageProvider $expressionLanguageProvider = null,
         EventDispatcherInterface $eventDispatcher = new EventDispatcher(),
+        ?EntityManagerInterface $entityManager = null,
     ): AutoMapper {
         $skipCacheRemove = $_SERVER['SKIP_CACHE_REMOVE'] ?? false;
 
@@ -52,6 +54,7 @@ classPrefix: $classPrefix,
             expressionLanguageProvider: $expressionLanguageProvider,
             eventDispatcher: $eventDispatcher,
             providers: $providers,
+            entityManager: $entityManager,
         );
     }
 }

tests/Doctrine/DoctrineTest.php

@@ -4,6 +4,7 @@
 
 namespace AutoMapper\Tests\Doctrine;
 
+use AutoMapper\Tests\AutoMapperBuilder;
 use AutoMapper\Tests\AutoMapperTestCase;
 use AutoMapper\Tests\Doctrine\Entity\Book;
 use Doctrine\DBAL\DriverManager;
@@ -23,9 +24,12 @@ protected function setUp(): void
     {
         parent::setUp();
         $this->buildDatabase();
+
+        $this->autoMapper = AutoMapperBuilder::buildAutoMapper(entityManager: $this->entityManager);
     }
 
-    private function buildDatabase() {
+    private function buildDatabase()
+    {
         // delete the database file
         if (file_exists(__DIR__ . '/db.sqlite')) {
             unlink(__DIR__ . '/db.sqlite');
@@ -70,4 +74,4 @@ public function testAutoMapping(): void
 
         $this->assertEquals('John Doe', $book->author);
     }
-}
+}

tests/Doctrine/Entity/Book.php

@@ -26,11 +26,11 @@ class Book
     public string $author = '';
 
     #[ORM\OneToMany(targetEntity: Review::class, mappedBy: 'book', cascade: ['persist', 'remove'])]
+    /** @var Collection<int, Review> */
     public Collection $reviews;
 
     public function __construct()
     {
         $this->reviews = new ArrayCollection();
-
     }
 }