Extract new logic so the attribute driver can use it as well

mpdude · mpdude · commit 03f39f912f1e · 2023-01-25T23:04:16.000Z
diff --git a/lib/Doctrine/ORM/Mapping/Driver/AnnotationDriver.php b/lib/Doctrine/ORM/Mapping/Driver/AnnotationDriver.php
@@ -34,6 +34,7 @@
 class AnnotationDriver extends CompatibilityAnnotationDriver
 {
     use ColocatedMappingDriver;
+    use ReflectionBasedDriverTrait;
 
     /**
      * The annotation reader.
@@ -344,37 +345,7 @@ public function loadMetadataForClass($className, PersistenceClassMetadata $metad
 
         // Evaluate annotations on properties/fields
         foreach ($class->getProperties() as $property) {
-            // Handle the case that reflection may report properties inherited from parent classes.
-            // When we know about the fields already (inheritance has been anticipanted in ClassMetadataFactory),
-            // skip them.
-            // The declaring classes may mismatch when there are private properties: The same property name may be
-            // reported multiple times, but since it is private, it is in fact multiple (different) properties in
-            // different classes. In that case, report the property as an individual field. (ClassMetadataFactory will
-            // probably fail in that case, though.)
-
-            $declaringClass = $property->getDeclaringClass()->getName();
-
-            if (
-                isset($metadata->fieldMappings[$property->name])
-                && isset($metadata->fieldMappings[$property->name]['declared'])
-                && $metadata->fieldMappings[$property->name]['declared'] === $declaringClass
-            ) {
-                continue;
-            }
-
-            if (
-                isset($metadata->associationMappings[$property->name])
-                && isset($metadata->associationMappings[$property->name]['declared'])
-                && $metadata->associationMappings[$property->name]['declared'] === $declaringClass
-            ) {
-                continue;
-            }
-
-            if (
-                isset($metadata->embeddedClasses[$property->name])
-                && isset($metadata->embeddedClasses[$property->name]['declared'])
-                && $metadata->embeddedClasses[$property->name]['declared'] === $declaringClass
-            ) {
+            if ($this->isRepeatedPropertyDeclaration($property, $metadata)) {
                 continue;
             }
 
diff --git a/lib/Doctrine/ORM/Mapping/Driver/AttributeDriver.php b/lib/Doctrine/ORM/Mapping/Driver/AttributeDriver.php
@@ -30,6 +30,7 @@
 class AttributeDriver extends CompatibilityAnnotationDriver
 {
     use ColocatedMappingDriver;
+    use ReflectionBasedDriverTrait;
 
     private const ENTITY_ATTRIBUTE_CLASSES = [
         Mapping\Entity::class => 1,
@@ -294,15 +295,8 @@ public function loadMetadataForClass($className, PersistenceClassMetadata $metad
 
         foreach ($reflectionClass->getProperties() as $property) {
             assert($property instanceof ReflectionProperty);
-            if (
-                $metadata->isMappedSuperclass && ! $property->isPrivate()
-                ||
-                $metadata->isInheritedField($property->name)
-                ||
-                $metadata->isInheritedAssociation($property->name)
-                ||
-                $metadata->isInheritedEmbeddedClass($property->name)
-            ) {
+
+            if ($this->isRepeatedPropertyDeclaration($property, $metadata)) {
                 continue;
             }
 
diff --git a/lib/Doctrine/ORM/Mapping/Driver/ReflectionBasedDriverTrait.php b/lib/Doctrine/ORM/Mapping/Driver/ReflectionBasedDriverTrait.php
@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\ORM\Mapping\Driver;
+
+use Doctrine\ORM\Mapping\ClassMetadata;
+use ReflectionProperty;
+
+trait ReflectionBasedDriverTrait
+{
+    /**
+     * Helps to deal with the case that reflection may report properties inherited from parent classes.
+     * When we know about the fields already (inheritance has been anticipated in ClassMetadataFactory),
+     * the driver must skip them.
+     *
+     * The declaring classes may mismatch when there are private properties: The same property name may be
+     * reported multiple times, but since it is private, it is in fact multiple (different) properties in
+     * different classes. In that case, report the property as an individual field. (ClassMetadataFactory will
+     * probably fail in that case, though.)
+     */
+    private function isRepeatedPropertyDeclaration(ReflectionProperty $property, ClassMetadata $metadata): bool
+    {
+        $declaringClass = $property->getDeclaringClass()->getName();
+
+        if (
+            isset($metadata->fieldMappings[$property->name])
+            && isset($metadata->fieldMappings[$property->name]['declared'])
+            && $metadata->fieldMappings[$property->name]['declared'] === $declaringClass
+        ) {
+            return true;
+        }
+
+        if (
+            isset($metadata->associationMappings[$property->name])
+            && isset($metadata->associationMappings[$property->name]['declared'])
+            && $metadata->associationMappings[$property->name]['declared'] === $declaringClass
+        ) {
+            return true;
+        }
+
+        return isset($metadata->embeddedClasses[$property->name])
+            && isset($metadata->embeddedClasses[$property->name]['declared'])
+            && $metadata->embeddedClasses[$property->name]['declared'] === $declaringClass;
+    }
+}
