Merge pull request #9 from binafy/add-support-ulid-uuid

[0.x] Add support `UUID` & `ULID`

Author: milwad-dev

config/user-monitoring.php

@@ -7,10 +7,32 @@
      * You can customize the user guard, table, foreign key, and ... .
      */
     'user' => [
+        /*
+         * User model.
+         */
         'model' => 'App\Models\User',
+
+        /*
+         * Foreign Key column name.
+         */
         'foreign_key' => 'user_id',
-        'tables' => 'users',
+
+        /*
+         * Users table name.
+         */
+        'table' => 'users',
+
+        /*
+         * The correct guard.
+         */
         'guard' => 'web',
+
+        /*
+         * If you are using uuid or ulid you can change it for type of foreign_key.
+         *
+         * When you are using ulid or uuid, you need to add related trait into the models.
+         */
+        'foreign_key_type' => 'id', // uuid, ulid, id
     ],
 
     /*

database/migrations/2023_07_22_230401_create_visits_monitoring_table.php

@@ -1,5 +1,6 @@
 <?php
 
+use Binafy\LaravelUserMonitoring\Utills\UserUtils;
 use Illuminate\Database\Migrations\Migration;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
@@ -13,10 +14,8 @@ public function up(): void
     {
         Schema::create(config('user-monitoring.visit_monitoring.table'), function (Blueprint $table) {
             $table->id();
-            $table->foreignId(config('user-monitoring.user.foreign_key'))
-                ->nullable()
-                ->constrained(config('user-monitoring.user.tables'))
-                ->nullOnDelete();
+
+            UserUtils::userForeignKey($table);
 
             $table->string('browser_name');
             $table->string('platform');

database/migrations/2023_07_23_145723_create_actions_monitoring_table.php

@@ -1,5 +1,6 @@
 <?php
 
+use Binafy\LaravelUserMonitoring\Utills\UserUtils;
 use Illuminate\Database\Migrations\Migration;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
@@ -13,10 +14,8 @@ public function up(): void
     {
         Schema::create(config('user-monitoring.action_monitoring.table'), function (Blueprint $table) {
             $table->id();
-            $table->foreignId(config('user-monitoring.user.foreign_key'))
-                ->nullable()
-                ->constrained(config('user-monitoring.user.tables'))
-                ->nullOnDelete();
+
+            UserUtils::userForeignKey($table);
 
             $table->string('action_type');
             $table->string('table_name');

database/migrations/2023_07_25_132642_create_authentications_monitoring_table.php

@@ -1,5 +1,6 @@
 <?php
 
+use Binafy\LaravelUserMonitoring\Utills\UserUtils;
 use Illuminate\Database\Migrations\Migration;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
@@ -15,17 +16,27 @@ public function up(): void
             $table->id();
 
             if (config('user-monitoring.authentication_monitoring.delete_user_record_when_user_delete', true)) {
-                $table->foreignId(config('user-monitoring.user.foreign_key'))
-                    ->constrained(config('user-monitoring.user.tables'))
-                    ->cascadeOnDelete();
+                if (config('user-monitoring.user.foreign_key_type') === 'ulid') {
+                    $table->foreignUlid(config('user-monitoring.user.foreign_key'))
+                        ->nullable()
+                        ->constrained(config('user-monitoring.user.table'))
+                        ->cascadeOnDelete();
+                } else if (config('user-monitoring.user.foreign_key_type') === 'uuid') {
+                    $table->foreignUuid(config('user-monitoring.user.foreign_key'))
+                        ->nullable()
+                        ->constrained(config('user-monitoring.user.table'))
+                        ->cascadeOnDelete();
+                } else {
+                    $table->foreignId(config('user-monitoring.user.foreign_key'))
+                        ->nullable()
+                        ->constrained(config('user-monitoring.user.table'))
+                        ->cascadeOnDelete();
+                }
             } else {
-                $table->foreignId(config('user-monitoring.user.foreign_key'))
-                    ->constrained(config('user-monitoring.user.tables'))
-                    ->nullOnDelete();
+                UserUtils::userForeignKey($table);
             }
 
             $table->string('action_type');
-
             $table->string('browser_name');
             $table->string('platform');
             $table->string('device');

src/Utills/UserUtils.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Binafy\LaravelUserMonitoring\Utills;
+
+use Illuminate\Database\Schema\Blueprint;
+
+class UserUtils
+{
+    public static function userForeignKey(Blueprint $table)
+    {
+        $type = config('user-monitoring.user.foreign_key_type', 'id');
+
+        if ($type === 'ulid') {
+            $table->foreignUlid(config('user-monitoring.user.foreign_key'))
+                ->nullable()
+                ->constrained(config('user-monitoring.user.table'))
+                ->nullOnDelete();
+        } else if ($type === 'uuid') {
+            $table->foreignUuid(config('user-monitoring.user.foreign_key'))
+                ->nullable()
+                ->constrained(config('user-monitoring.user.table'))
+                ->nullOnDelete();
+        } else {
+            $table->foreignId(config('user-monitoring.user.foreign_key'))
+                ->nullable()
+                ->constrained(config('user-monitoring.user.table'))
+                ->nullOnDelete();
+        }
+    }
+}