feat(types): allow to extract from getter on target

joelwurtz · joelwurtz · commit 3fd739d24d97 · 2025-04-05T13:33:25.000+02:00
diff --git a/castor.php b/castor.php
@@ -39,9 +39,22 @@ function debug_mapper(string $source, string $target, string $load = '')
 {
     require_once __DIR__ . '/vendor/autoload.php';
 
-    if ($load) {
-        require_once $load;
-    }
+    // special autoloader for "AutoMapperTests"
+    spl_autoload_register(function (string $class) {
+        if (!str_starts_with($class, 'AutoMapper\\Tests\\AutoMapperTest\\')) {
+            return false;
+        }
+
+        // split on namespace separator
+        $parts = explode('\\', $class);
+        // get second part
+        $testDirectory = $parts[3] ?? '';
+        $mapFile = __DIR__ . '/tests/AutoMapperTest/' . $testDirectory . '/map.php';
+
+        if (file_exists($mapFile)) {
+            require_once $mapFile;
+        }
+    });
 
     $automapper = AutoMapper\AutoMapper::create();
     // get private property loader value
diff --git a/src/Attribute/MapFrom.php b/src/Attribute/MapFrom.php
@@ -11,14 +11,15 @@
 final readonly class MapFrom
 {
     /**
-     * @param class-string<object>|'array'|array<class-string<object>|'array'>|null                                    $source         The specific source class name or array. If null this attribute will be used for all source classes.
-     * @param string|null                                                                                              $property       The source property name. If null, the target property name will be used.
-     * @param int|null                                                                                                 $maxDepth       The maximum depth of the mapping. If null, the default max depth will be used.
-     * @param string|callable(mixed $value, object|array<string, mixed> $source, array<string, mixed> $context): mixed $transformer    A transformer id or a callable that transform the value during mapping
-     * @param bool|null                                                                                                $ignore         If true, the property will be ignored during mapping
-     * @param string|null                                                                                              $if             The condition to map the property, using the expression language
-     * @param string[]|null                                                                                            $groups         The groups to map the property
-     * @param string|null                                                                                              $dateTimeFormat The date-time format to use when transforming this property
+     * @param class-string<object>|'array'|array<class-string<object>|'array'>|null                                    $source                 The specific source class name or array. If null this attribute will be used for all source classes.
+     * @param string|null                                                                                              $property               The source property name. If null, the target property name will be used.
+     * @param int|null                                                                                                 $maxDepth               The maximum depth of the mapping. If null, the default max depth will be used.
+     * @param string|callable(mixed $value, object|array<string, mixed> $source, array<string, mixed> $context): mixed $transformer            A transformer id or a callable that transform the value during mapping
+     * @param bool|null                                                                                                $ignore                 If true, the property will be ignored during mapping
+     * @param string|null                                                                                              $if                     The condition to map the property, using the expression language
+     * @param string[]|null                                                                                            $groups                 The groups to map the property
+     * @param string|null                                                                                              $dateTimeFormat         The date-time format to use when transforming this property
+     * @param bool|null                                                                                                $extractTypesFromGetter If true, the types will be extracted from the getter method
      */
     public function __construct(
         public string|array|null $source = null,
@@ -30,6 +31,7 @@ public function __construct(
         public ?array $groups = null,
         public int $priority = 0,
         public ?string $dateTimeFormat = null,
+        public ?bool $extractTypesFromGetter = null,
     ) {
     }
 }
diff --git a/src/Attribute/MapTo.php b/src/Attribute/MapTo.php
@@ -11,14 +11,15 @@
 final readonly class MapTo
 {
     /**
-     * @param class-string<object>|'array'|array<class-string<object>|'array'>|null                                    $target         The specific target class name or array. If null this attribute will be used for all target classes.
-     * @param string|null                                                                                              $property       The target property name. If null, the source property name will be used.
-     * @param int|null                                                                                                 $maxDepth       The maximum depth of the mapping. If null, the default max depth will be used.
-     * @param string|callable(mixed $value, object|array<string, mixed> $source, array<string, mixed> $context): mixed $transformer    A transformer id or a callable that transform the value during mapping
-     * @param bool|null                                                                                                $ignore         If true, the property will be ignored during mapping
-     * @param string|null                                                                                              $if             The condition to map the property, using the expression language
-     * @param string[]|null                                                                                            $groups         The groups to map the property
-     * @param string|null                                                                                              $dateTimeFormat The date-time format to use when transforming this property
+     * @param class-string<object>|'array'|array<class-string<object>|'array'>|null                                    $target                 The specific target class name or array. If null this attribute will be used for all target classes.
+     * @param string|null                                                                                              $property               The target property name. If null, the source property name will be used.
+     * @param int|null                                                                                                 $maxDepth               The maximum depth of the mapping. If null, the default max depth will be used.
+     * @param string|callable(mixed $value, object|array<string, mixed> $source, array<string, mixed> $context): mixed $transformer            A transformer id or a callable that transform the value during mapping
+     * @param bool|null                                                                                                $ignore                 If true, the property will be ignored during mapping
+     * @param string|null                                                                                              $if                     The condition to map the property, using the expression language
+     * @param string[]|null                                                                                            $groups                 The groups to map the property
+     * @param string|null                                                                                              $dateTimeFormat         The date-time format to use when transforming this property
+     * @param bool|null                                                                                                $extractTypesFromGetter If true, the types will be extracted from the getter method
      */
     public function __construct(
         public string|array|null $target = null,
@@ -30,6 +31,7 @@ public function __construct(
         public ?array $groups = null,
         public int $priority = 0,
         public ?string $dateTimeFormat = null,
+        public ?bool $extractTypesFromGetter = null,
     ) {
     }
 }
diff --git a/src/Configuration.php b/src/Configuration.php
@@ -50,6 +50,14 @@ public function __construct(
          * Allow extra properties to be mapped when the target or the source implements ArrayAccess class.
          */
         public bool $allowExtraProperties = false,
+        /**
+         * When extracting types from a target property we generally try to use the one from where we write.
+         *
+         * However, this may cause bad type in case of covariance where the type should be extracted from the setter.
+         *
+         * Enable this option to extract the type from the getter instead of the setter.
+         */
+        public bool $extractTypesFromGetter = false,
     ) {
     }
 }
diff --git a/src/Event/PropertyMetadataEvent.php b/src/Event/PropertyMetadataEvent.php
@@ -31,6 +31,7 @@ public function __construct(
         public ?bool $disableGroupsCheck = null,
         public int $priority = 0,
         public readonly bool $isFromDefaultExtractor = false,
+        public ?bool $extractTypesFromGetter = null,
     ) {
     }
 }
diff --git a/src/EventListener/MapFromListener.php b/src/EventListener/MapFromListener.php
@@ -71,7 +71,7 @@ private function addPropertyFromTarget(GenerateMapperEvent $event, MapFrom $mapF
         $sourceProperty = new SourcePropertyMetadata($mapFrom->property ?? $property);
         $targetProperty = new TargetPropertyMetadata($property);
 
-        $property = new PropertyMetadataEvent(
+        $propertyMetadata = new PropertyMetadataEvent(
             mapperMetadata: $event->mapperMetadata,
             source: $sourceProperty,
             target: $targetProperty,
@@ -83,12 +83,13 @@ private function addPropertyFromTarget(GenerateMapperEvent $event, MapFrom $mapF
             if: $mapFrom->if,
             groups: $mapFrom->groups,
             priority: $mapFrom->priority,
+            extractTypesFromGetter: $mapFrom->extractTypesFromGetter,
         );
 
-        if (\array_key_exists($property->target->property, $event->properties) && $event->properties[$property->target->property]->priority >= $property->priority) {
+        if (\array_key_exists($propertyMetadata->target->property, $event->properties) && $event->properties[$propertyMetadata->target->property]->priority >= $propertyMetadata->priority) {
             return;
         }
 
-        $event->properties[$property->target->property] = $property;
+        $event->properties[$propertyMetadata->target->property] = $propertyMetadata;
     }
 }
diff --git a/src/EventListener/MapToListener.php b/src/EventListener/MapToListener.php
@@ -72,7 +72,7 @@ private function addPropertyFromSource(GenerateMapperEvent $event, MapTo $mapTo,
         $sourceProperty = new SourcePropertyMetadata($property);
         $targetProperty = new TargetPropertyMetadata($mapTo->property ?? $property);
 
-        $property = new PropertyMetadataEvent(
+        $propertyMetadata = new PropertyMetadataEvent(
             mapperMetadata: $event->mapperMetadata,
             source: $sourceProperty,
             target: $targetProperty,
@@ -84,12 +84,13 @@ private function addPropertyFromSource(GenerateMapperEvent $event, MapTo $mapTo,
             if: $mapTo->if,
             groups: $mapTo->groups,
             priority: $mapTo->priority,
+            extractTypesFromGetter: $mapTo->extractTypesFromGetter,
         );
 
-        if (\array_key_exists($property->target->property, $event->properties) && $event->properties[$property->target->property]->priority >= $property->priority) {
+        if (\array_key_exists($propertyMetadata->target->property, $event->properties) && $event->properties[$propertyMetadata->target->property]->priority >= $propertyMetadata->priority) {
             return;
         }
 
-        $event->properties[$property->target->property] = $property;
+        $event->properties[$propertyMetadata->target->property] = $propertyMetadata;
     }
 }
diff --git a/src/Extractor/FromSourceMappingExtractor.php b/src/Extractor/FromSourceMappingExtractor.php
@@ -20,7 +20,7 @@
  */
 final class FromSourceMappingExtractor extends MappingExtractor
 {
-    public function getTypes(string $source, SourcePropertyMetadata $sourceProperty, string $target, TargetPropertyMetadata $targetProperty): TypesMatching
+    public function getTypes(string $source, SourcePropertyMetadata $sourceProperty, string $target, TargetPropertyMetadata $targetProperty, bool $extractTypesFromGetter): TypesMatching
     {
         $types = new TypesMatching();
         $sourceTypes = $this->propertyInfoExtractor->getTypes($source, $sourceProperty->property, [
diff --git a/src/Extractor/FromTargetMappingExtractor.php b/src/Extractor/FromTargetMappingExtractor.php
@@ -20,11 +20,12 @@
  */
 final class FromTargetMappingExtractor extends MappingExtractor
 {
-    public function getTypes(string $source, SourcePropertyMetadata $sourceProperty, string $target, TargetPropertyMetadata $targetProperty): TypesMatching
+    public function getTypes(string $source, SourcePropertyMetadata $sourceProperty, string $target, TargetPropertyMetadata $targetProperty, bool $extractTypesFromGetter): TypesMatching
     {
         $types = new TypesMatching();
         $targetTypes = $this->propertyInfoExtractor->getTypes($target, $targetProperty->property, [
             ReadWriteTypeExtractor::WRITE_MUTATOR => $targetProperty->writeMutator,
+            ReadWriteTypeExtractor::EXTRACT_TYPE_FROM_GETTER => $extractTypesFromGetter,
         ]) ?? [];
 
         foreach ($targetTypes as $type) {
diff --git a/src/Extractor/MappingExtractorInterface.php b/src/Extractor/MappingExtractorInterface.php
@@ -27,7 +27,7 @@ interface MappingExtractorInterface
      */
     public function getProperties(string $class): iterable;
 
-    public function getTypes(string $source, SourcePropertyMetadata $sourceProperty, string $target, TargetPropertyMetadata $targetProperty): TypesMatching;
+    public function getTypes(string $source, SourcePropertyMetadata $sourceProperty, string $target, TargetPropertyMetadata $targetProperty, bool $extractTypesFromGetter): TypesMatching;
 
     public function getDateTimeFormat(PropertyMetadataEvent $propertyMetadataEvent): string;
 
diff --git a/src/Extractor/ReadWriteTypeExtractor.php b/src/Extractor/ReadWriteTypeExtractor.php
@@ -18,6 +18,7 @@
 {
     public const READ_ACCESSOR = 'read_accessor';
     public const WRITE_MUTATOR = 'write_mutator';
+    public const EXTRACT_TYPE_FROM_GETTER = 'extract_type_from_getter';
 
     /**
      * @param array<string, mixed> $context
@@ -28,7 +29,7 @@ public function getTypes(string $class, string $property, array $context = []):
             return $accessor->getTypes($class);
         }
 
-        if (($mutator = $context[self::WRITE_MUTATOR] ?? false) && $mutator instanceof WriteMutator) {
+        if (!($context[self::EXTRACT_TYPE_FROM_GETTER] ?? false) && ($mutator = $context[self::WRITE_MUTATOR] ?? false) && $mutator instanceof WriteMutator) {
             return $mutator->getTypes($class);
         }
 
diff --git a/src/Extractor/SourceTargetMappingExtractor.php b/src/Extractor/SourceTargetMappingExtractor.php
@@ -17,10 +17,10 @@
  */
 class SourceTargetMappingExtractor extends MappingExtractor
 {
-    public function getTypes(string $source, SourcePropertyMetadata $sourceProperty, string $target, TargetPropertyMetadata $targetProperty): TypesMatching
+    public function getTypes(string $source, SourcePropertyMetadata $sourceProperty, string $target, TargetPropertyMetadata $targetProperty, bool $extractTypesFromGetter): TypesMatching
     {
         $sourceTypes = $this->propertyInfoExtractor->getTypes($source, $sourceProperty->property, [ReadWriteTypeExtractor::READ_ACCESSOR => $sourceProperty->accessor]) ?? [];
-        $targetTypes = $this->propertyInfoExtractor->getTypes($target, $targetProperty->property, [ReadWriteTypeExtractor::WRITE_MUTATOR => $targetProperty->writeMutator]) ?? [];
+        $targetTypes = $this->propertyInfoExtractor->getTypes($target, $targetProperty->property, [ReadWriteTypeExtractor::WRITE_MUTATOR => $targetProperty->writeMutator, ReadWriteTypeExtractor::EXTRACT_TYPE_FROM_GETTER => $extractTypesFromGetter]) ?? [];
 
         return TypesMatching::fromSourceAndTargetTypes($sourceTypes, $targetTypes);
     }
diff --git a/src/Metadata/MetadataFactory.php b/src/Metadata/MetadataFactory.php
@@ -286,7 +286,7 @@ private function createGeneratorMetadata(MapperMetadata $mapperMetadata): Genera
             $targetPropertyMetadata = TargetPropertyMetadata::fromEvent($propertyMappedEvent->target);
 
             if (null === $propertyMappedEvent->types) {
-                $propertyMappedEvent->types = $extractor->getTypes($mapperMetadata->source, $sourcePropertyMetadata, $mapperMetadata->target, $targetPropertyMetadata);
+                $propertyMappedEvent->types = $extractor->getTypes($mapperMetadata->source, $sourcePropertyMetadata, $mapperMetadata->target, $targetPropertyMetadata, $propertyMappedEvent->extractTypesFromGetter ?? $this->configuration->extractTypesFromGetter);
             }
 
             if (null === $propertyMappedEvent->transformer) {
diff --git a/tests/AutoMapperTest/Covariance/expected.data b/tests/AutoMapperTest/Covariance/expected.data
@@ -0,0 +1,3 @@
+AutoMapper\Tests\AutoMapperTest\Covariance\ExtendedA {
+  #b: AutoMapper\Tests\AutoMapperTest\Covariance\ExtendedB {}
+}
diff --git a/tests/AutoMapperTest/Covariance/map.php b/tests/AutoMapperTest/Covariance/map.php
@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AutoMapper\Tests\AutoMapperTest\Covariance;
+
+use AutoMapper\Attribute\MapTo;
+use AutoMapper\Tests\AutoMapperBuilder;
+
+class GenericB
+{
+}
+
+class GenericA
+{
+    /**
+     * @var GenericB
+     */
+    #[MapTo(extractTypesFromGetter: true)]
+    protected $b;
+
+    public function getB(): GenericB
+    {
+        return $this->b;
+    }
+
+    public function setB(GenericB $b): void
+    {
+        $this->b = $b;
+    }
+}
+
+class ExtendedB extends GenericB
+{
+    public function specificToB(): string
+    {
+        return 'result from ExtendedB';
+    }
+}
+
+class ExtendedA extends GenericA
+{
+    /**
+     * @var ExtendedB
+     */
+    protected $b;
+
+    public function getB(): ExtendedB
+    {
+        return $this->b;
+    }
+}
+
+$autoMapper = AutoMapperBuilder::buildAutoMapper(mapPrivatePropertiesAndMethod: true);
+
+$genericA = new GenericA();
+$genericB = new GenericB();
+$genericA->setB($genericB);
+
+return $autoMapper->map($genericA, ExtendedA::class);

Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,7 @@ public function __construct(`
`31`	`31`	`public ?bool $disableGroupsCheck = null,`
`32`	`32`	`public int $priority = 0,`
`33`	`33`	`public readonly bool $isFromDefaultExtractor = false,`
	`34`	`+ public ?bool $extractTypesFromGetter = null,`
`34`	`35`	`) {`
`35`	`36`	`}`
`36`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`*/`
`21`	`21`	`final class FromSourceMappingExtractor extends MappingExtractor`
`22`	`22`	`{`
`23`		`- public function getTypes(string $source, SourcePropertyMetadata $sourceProperty, string $target, TargetPropertyMetadata $targetProperty): TypesMatching`
	`23`	`+ public function getTypes(string $source, SourcePropertyMetadata $sourceProperty, string $target, TargetPropertyMetadata $targetProperty, bool $extractTypesFromGetter): TypesMatching`
`24`	`24`	`{`
`25`	`25`	`$types = new TypesMatching();`
`26`	`26`	`$sourceTypes = $this->propertyInfoExtractor->getTypes($source, $sourceProperty->property, [`
Original file line number	Diff line number	Diff line change
`@@ -20,11 +20,12 @@`
`20`	`20`	`*/`
`21`	`21`	`final class FromTargetMappingExtractor extends MappingExtractor`
`22`	`22`	`{`
`23`		`- public function getTypes(string $source, SourcePropertyMetadata $sourceProperty, string $target, TargetPropertyMetadata $targetProperty): TypesMatching`
	`23`	`+ public function getTypes(string $source, SourcePropertyMetadata $sourceProperty, string $target, TargetPropertyMetadata $targetProperty, bool $extractTypesFromGetter): TypesMatching`
`24`	`24`	`{`
`25`	`25`	`$types = new TypesMatching();`
`26`	`26`	`$targetTypes = $this->propertyInfoExtractor->getTypes($target, $targetProperty->property, [`
`27`	`27`	`ReadWriteTypeExtractor::WRITE_MUTATOR => $targetProperty->writeMutator,`
	`28`	`+ ReadWriteTypeExtractor::EXTRACT_TYPE_FROM_GETTER => $extractTypesFromGetter,`
`28`	`29`	`]) ?? [];`
`29`	`30`
`30`	`31`	`foreach ($targetTypes as $type) {`