feat: allow setting foreign key as deferrable

doctrine · Aug 1, 2023 · 05d8f4e · 05d8f4e
1 parent 710dde8
commit 05d8f4e
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 0 deletions.
diff --git a/lib/Doctrine/ORM/Mapping/ClassMetadata.php b/lib/Doctrine/ORM/Mapping/ClassMetadata.php
@@ -47,6 +47,7 @@
  *     onDelete?: string,
  *     columnDefinition?: string,
  *     nullable?: bool,
+ *     options?: array<string, mixed>,
  * }
  * @psalm-type AssociationMapping = array{
  *     cache?: array,

diff --git a/lib/Doctrine/ORM/Tools/SchemaTool.php b/lib/Doctrine/ORM/Tools/SchemaTool.php
@@ -763,6 +763,10 @@ private function gatherRelationJoinColumns(
             if (isset($joinColumn['onDelete'])) {
                 $fkOptions['onDelete'] = $joinColumn['onDelete'];
             }
+
+            if (isset($joinColumn['options']['deferrable'])) {
+                $fkOptions['deferrable'] = $joinColumn['options']['deferrable'];
+            }
         }
 
         // Prefer unique constraints over implicit simple indexes created for foreign keys.

diff --git a/tests/Doctrine/Tests/ORM/Functional/SchemaTool/PostgreSqlSchemaToolTest.php b/tests/Doctrine/Tests/ORM/Functional/SchemaTool/PostgreSqlSchemaToolTest.php
@@ -16,6 +16,7 @@
 use Doctrine\Tests\OrmFunctionalTestCase;
 
 use function array_filter;
+use function array_values;
 use function implode;
 use function str_starts_with;
 
@@ -51,6 +52,20 @@ public function testUpdateSchemaWithPostgreSQLSchema(): void
 
         self::assertCount(0, $sql, implode("\n", $sql));
     }
+
+    public function testSetDeferrableForeignKey(): void
+    {
+        $schema = $this->getSchemaForModels(
+            EntityWithSelfReferencingAssociation::class
+        );
+
+        $table = $schema->getTable('postgres.entitywithselfreferencingassociation');
+        $fks   = array_values($table->getForeignKeys());
+
+        self::assertCount(1, $fks);
+
+        self::assertTrue($fks[0]->getOption('deferrable'));
+    }
 }
 
 /**
@@ -119,3 +134,26 @@ class DDC1657Avatar
      */
     private $pk;
 }
+
+/**
+ * @Entity
+ */
+class EntityWithSelfReferencingAssociation
+{
+    /**
+     * Identifier
+     *
+     * @var int
+     * @Id
+     * @GeneratedValue(strategy="IDENTITY")
+     * @Column(type="integer", nullable=false)
+     */
+    private $id;
+
+    /**
+     * @var EntityWithSelfReferencingAssociation
+     * @ManyToOne(targetEntity="EntityWithSelfReferencingAssociation")
+     * @JoinColumn(options={"deferrable": true})
+     */
+    private $parent;
+}