Add Fully-Qualified class name in UnrecognizedField exception to ease…

… debugging
doctrine · Dec 30, 2022 · 2de8a96 · 2de8a96
1 parent 27df173
commit 2de8a96
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 3 deletions.
diff --git a/lib/Doctrine/ORM/Persisters/Entity/BasicEntityPersister.php b/lib/Doctrine/ORM/Persisters/Entity/BasicEntityPersister.php
@@ -487,7 +487,7 @@ final protected function updateTable(
             $targetType    = PersisterHelper::getTypeOfField($targetMapping->identifier[0], $targetMapping, $this->em);
 
             if ($targetType === []) {
-                throw UnrecognizedField::byName($targetMapping->identifier[0]);
+                throw UnrecognizedField::byFullyQualifiedName($this->class->name, $targetMapping->identifier[0]);
             }
 
             $types[] = reset($targetType);
@@ -1199,7 +1199,7 @@ final protected function getOrderBySQL(array $orderBy, string $baseTableAlias):
                 continue;
             }
 
-            throw UnrecognizedField::byName($fieldName);
+            throw UnrecognizedField::byFullyQualifiedName($this->class->name, $fieldName);
         }
 
         return ' ORDER BY ' . implode(', ', $orderByList);
@@ -1757,7 +1757,7 @@ private function getSelectConditionStatementColumnSQL(
             return [$field];
         }
 
-        throw UnrecognizedField::byName($field);
+        throw UnrecognizedField::byFullyQualifiedName($this->class->name, $field);
     }
 
     /**

diff --git a/lib/Doctrine/ORM/Persisters/Exception/UnrecognizedField.php b/lib/Doctrine/ORM/Persisters/Exception/UnrecognizedField.php
@@ -10,8 +10,15 @@
 
 final class UnrecognizedField extends PersisterException
 {
+    /** @deprecated This method is deprecated and will be removed in Doctrine ORM 3.0. Use {@see byFullyQualifiedName} instead */
     public static function byName(string $field): self
     {
         return new self(sprintf('Unrecognized field: %s', $field));
     }
+
+    /** @param class-string $className */
+    public static function byFullyQualifiedName(string $className, string $field): self
+    {
+        return new self(sprintf('Unrecognized field: %s::%s', $className, $field));
+    }
 }
diff --git a/tests/Doctrine/Tests/ORM/Persisters/Exception/UnrecognizedFieldTest.php b/tests/Doctrine/Tests/ORM/Persisters/Exception/UnrecognizedFieldTest.php
@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Tests\ORM\Persisters\Exception;
+
+use Doctrine\ORM\Persisters\Exception\UnrecognizedField;
+use Doctrine\Tests\Models\Taxi\Car;
+use PHPUnit\Framework\TestCase;
+
+class UnrecognizedFieldTest extends TestCase
+{
+    public function testByFullyQualifiedName(): void
+    {
+        static::expectException(UnrecognizedField::class);
+        static::expectExceptionMessage('Unrecognized field: Doctrine\Tests\Models\Taxi\Car::color');
+
+        throw UnrecognizedField::byFullyQualifiedName(Car::class, 'color');
+    }
+}