feat(database): add foreignId alias to belongsTo

Author: innocenzi

packages/database/src/QueryStatements/CreateTableStatement.php

@@ -43,7 +43,7 @@ public function primary(string $name = 'id'): self
     }
 
     /**
-     * Adds an integer column with a foreign key relationship to another table.
+     * Adds an integer column with a foreign key relationship to another table. This is an alias to `foreignId`.
      *
      * **Example**
      * ```php
@@ -69,13 +69,43 @@ public function belongsTo(string $local, string $foreign, OnDelete $onDelete = O
         return $this;
     }
 
+    /**
+     * Adds an integer column with a foreign key relationship to another table.
+     *
+     * **Example**
+     * ```php
+     * new CreateTableStatement('orders')
+     *   ->foreignId('customer_id', constrainedOn: 'customers');
+     * ```
+     * ```php
+     * new CreateTableStatement('orders')
+     *   ->foreignId('orders.customer_id', constrainedOn: 'customers.id');
+     * ```
+     *
+     * @param string $local The local column in the format `[this_table.]foreign_id`.
+     * @param string $constrainedOn The foreign table in the format `other_table[.id]`.
+     */
+    public function foreignId(string $local, string $constrainedOn, OnDelete $onDelete = OnDelete::RESTRICT, OnUpdate $onUpdate = OnUpdate::NO_ACTION, bool $nullable = false): self
+    {
+        if (! str_contains($local, '.')) {
+            $local = $this->tableName . '.' . $local;
+        }
+
+        if (! str_contains($constrainedOn, '.')) {
+            $constrainedOn = $constrainedOn . '.id';
+        }
+
+        return $this->belongsTo($local, $constrainedOn, $onDelete, $onUpdate, $nullable);
+    }
+
     /**
      * Adds a foreign key constraint to another table.
      *
      * **Example**
      * ```php
-     * $table->integer('customer_id', nullable: false);
-     * $table->foreignKey('orders.customer_id', 'customers.id');
+     * new CreateTableStatement('orders')
+     *     ->integer('customer_id', nullable: false)
+     *     ->foreignKey('orders.customer_id', 'customers.id');
      * ```
      *
      * @param string $local The local column in the format `this_table.foreign_id`.

packages/database/tests/QueryStatements/CreateTableStatementTest.php

@@ -73,6 +73,22 @@ public function test_create_a_foreign_key_constraint(DatabaseDialect $dialect, s
             ->compile($dialect);
 
         $this->assertSame($validSql, $statement);
+
+        $statement = new CreateTableStatement('books')
+            ->primary()
+            ->foreignId('author_id', constrainedOn: 'authors', onDelete: OnDelete::CASCADE)
+            ->varchar('name')
+            ->compile($dialect);
+
+        $this->assertSame($validSql, $statement);
+
+        $statement = new CreateTableStatement('books')
+            ->primary()
+            ->foreignId('books.author_id', constrainedOn: 'authors.id', onDelete: OnDelete::CASCADE)
+            ->varchar('name')
+            ->compile($dialect);
+
+        $this->assertSame($validSql, $statement);
     }
 
     public static function provide_fk_create_table_database_drivers(): Generator