Merge pull request #42 from mattyforth/fix/user-uuid

[1.x] Add support for user UUIDs

Author: milwad-dev

README.md

@@ -14,6 +14,7 @@
 - [Publish](#publish)
 - [Usage](#usage)
     - [Configuration](#configuration)
+      - [User Configuration](#user-configuration) 
     - [Laravel Cart Facade](#laravel-cart-facade)
       - [Driver](#driver)
       - [Support Drivers](#support-drivers)
@@ -93,6 +94,23 @@ After publishing, run the `php artisan migrate` command.
 
 You can config the `Laravel Cart` with `laravel-cart.php` config that exists in `config` folder.
 
+<a name="user-configuration"></a>
+#### User Configuration
+
+If you are using `uuid` or `ulid`, you can change `foreign_key_type` to your correct foreign key type:
+
+```php
+'users' => [
+    ...
+
+    /*
+     * Specify the type of foreign key being used (e.g., 'id', 'uuid', 'ulid').
+     * For non-standard IDs, make sure to add the relevant traits to your models.
+     */
+    'foreign_key_type' => 'id', // Options: uuid, ulid, id
+],
+```
+
 <a name="laravel-cart-facade"></a>
 ### Laravel Cart Facade
 

config/laravel-cart.php

@@ -16,6 +16,12 @@
          * The user foreign key.
          */
         'foreign_id' => 'user_id',
+
+        /*
+         * Specify the type of foreign key being used (e.g., 'id', 'uuid', 'ulid').
+         * For non-standard IDs, make sure to add the relevant traits to your models.
+         */
+        'foreign_key_type' => 'id', // Options: uuid, ulid, id
     ],
 
     /*

database/migrations/2024_05_31_102710_create_carts_table.php

@@ -13,12 +13,25 @@ public function up(): void
     {
         $userTableName = config('laravel-cart.users.table', 'users');
         $userForeignName = config('laravel-cart.users.foreign_id', 'user_id');
+        $type = config('laravel-cart.users.foreign_key_type', 'id');
         $table = config('laravel-cart.carts.table', 'carts');
 
-        Schema::create($table, function (Blueprint $table) use ($userTableName, $userForeignName) {
+        Schema::create($table, function (Blueprint $table) use ($userTableName, $userForeignName, $type) {
             $table->id();
 
-            $table->foreignId($userForeignName)->constrained($userTableName)->cascadeOnDelete();
+            if ($type === 'ulid') {
+                $table->foreignUlid($userForeignName)
+                    ->constrained($userTableName)
+                    ->cascadeOnDelete();
+            } else if ($type === 'uuid') {
+                $table->foreignUuid($userForeignName)
+                    ->constrained($userTableName)
+                    ->cascadeOnDelete();
+            } else {
+                $table->foreignId($userForeignName)
+                    ->constrained($userTableName)
+                    ->cascadeOnDelete();
+            }
 
             $table->timestamps();
         });

src/Drivers/Driver.php

@@ -6,15 +6,15 @@
 
 interface Driver
 {
-    public function storeItem(Model|array $item, ?int $userId = null): Driver;
+    public function storeItem(Model|array $item, ?string $userId = null): Driver;
 
-    public function storeItems(array $items, ?int $userId = null): Driver;
+    public function storeItems(array $items, ?string $userId = null): Driver;
 
-    public function increaseQuantity(Model $item, int $quantity = 1, ?int $userId = null): Driver;
+    public function increaseQuantity(Model $item, int $quantity = 1, ?string $userId = null): Driver;
 
-    public function decreaseQuantity(Model $item, int $quantity = 1, ?int $userId = null): Driver;
+    public function decreaseQuantity(Model $item, int $quantity = 1, ?string $userId = null): Driver;
 
-    public function removeItem(Model $item, ?int $userId = null): Driver;
+    public function removeItem(Model $item, ?string $userId = null): Driver;
 
-    public function emptyCart(?int $userId = null): Driver;
+    public function emptyCart(?string $userId = null): Driver;
 }

src/Drivers/LaravelCartDatabase.php

@@ -11,7 +11,7 @@ class LaravelCartDatabase implements Driver
     /**
      * Store item in cart.
      */
-    public function storeItem(Model|array $item, ?int $userId = null): static
+    public function storeItem(Model|array $item, ?string $userId = null): static
     {
         $cart = Cart::query()->firstOrCreate(['user_id' => $this->resolveUserId($userId)]);
         $cart->storeItem($item);
@@ -22,7 +22,7 @@ public function storeItem(Model|array $item, ?int $userId = null): static
     /**
      * Store multiple items in cart.
      */
-    public function storeItems(array $items, ?int $userId = null): static
+    public function storeItems(array $items, ?string $userId = null): static
     {
         $cart = Cart::query()->firstOrCreate(['user_id' => $this->resolveUserId($userId)]);
         $cart->storeItems($items);
@@ -33,7 +33,7 @@ public function storeItems(array $items, ?int $userId = null): static
     /**
      * Increase the quantity of the item.
      */
-    public function increaseQuantity(Model $item, int $quantity = 1, ?int $userId = null): static
+    public function increaseQuantity(Model $item, int $quantity = 1, ?string $userId = null): static
     {
         $cart = Cart::query()->firstOrCreate(['user_id' => $this->resolveUserId($userId)]);
         $item = $cart->items()->firstWhere('itemable_id', $item->getKey());
@@ -50,7 +50,7 @@ public function increaseQuantity(Model $item, int $quantity = 1, ?int $userId =
     /**
      * Decrease the quantity of the item.
      */
-    public function decreaseQuantity(Model $item, int $quantity = 1, ?int $userId = null): static
+    public function decreaseQuantity(Model $item, int $quantity = 1, ?string $userId = null): static
     {
         $cart = Cart::query()->firstOrCreate(['user_id' => $this->resolveUserId($userId)]);
         $item = $cart->items()->firstWhere('itemable_id', $item->getKey());
@@ -67,7 +67,7 @@ public function decreaseQuantity(Model $item, int $quantity = 1, ?int $userId =
     /**
      * Remove a single item from the cart
      */
-    public function removeItem(Model $item, ?int $userId = null): static
+    public function removeItem(Model $item, ?string $userId = null): static
     {
         $cart = Cart::query()->firstOrCreate(['user_id' => $this->resolveUserId($userId)]);
         $itemToDelete = $cart->items()->find($item->getKey());
@@ -79,7 +79,7 @@ public function removeItem(Model $item, ?int $userId = null): static
     /**
      * Remove every item from the cart
      */
-    public function emptyCart(?int $userId = null): static
+    public function emptyCart(?string $userId = null): static
     {
         $cart = Cart::query()->firstOrCreate(['user_id' => $this->resolveUserId($userId)]);
         $cart->emptyCart();
@@ -90,7 +90,7 @@ public function emptyCart(?int $userId = null): static
     /**
      * Get option for item.
      */
-    public function getOption(string $option, ?int $itemId = null, ?int $userId = null): mixed
+    public function getOption(string $option, ?int $itemId = null, ?string $userId = null): mixed
     {
         $cart = Cart::query()->firstOrCreate(['user_id' => $this->resolveUserId($userId)]);
         $items = $cart->items()->when(! is_null($itemId), function (Builder $builder) use ($itemId) {
@@ -103,7 +103,7 @@ public function getOption(string $option, ?int $itemId = null, ?int $userId = nu
     /**
      * Get all options of one item.
      */
-    public function getOptions(?int $itemId = null, ?int $userId = null): mixed
+    public function getOptions(?int $itemId = null, ?string $userId = null): mixed
     {
         $cart = Cart::query()->firstOrCreate(['user_id' => $this->resolveUserId($userId)]);
         $items = $cart->items()->when(! is_null($itemId), function (Builder $builder) use ($itemId) {
@@ -116,7 +116,7 @@ public function getOptions(?int $itemId = null, ?int $userId = null): mixed
     /**
      * Set option for item.
      */
-    public function setOption(string $key, mixed $value, ?int $itemId = null, ?int $userId = null): static
+    public function setOption(string $key, mixed $value, ?int $itemId = null, ?string $userId = null): static
     {
         $cart = Cart::query()->firstOrCreate(['user_id' => $this->resolveUserId($userId)]);
         $items = $cart->items()->when(! is_null($itemId), function (Builder $builder) use ($itemId) {
@@ -131,7 +131,7 @@ public function setOption(string $key, mixed $value, ?int $itemId = null, ?int $
     /**
      * Get option for item.
      */
-    public function addOption(string $key, mixed $value, ?int $itemId = null, ?int $userId = null): static
+    public function addOption(string $key, mixed $value, ?int $itemId = null, ?string $userId = null): static
     {
         $cart = Cart::query()->firstOrCreate(['user_id' => $this->resolveUserId($userId)]);
         $items = $cart->items()->when(! is_null($itemId), function (Builder $builder) use ($itemId) {
@@ -146,7 +146,7 @@ public function addOption(string $key, mixed $value, ?int $itemId = null, ?int $
     /**
      * Resolve the user ID, defaulting to the authenticated user.
      */
-    protected function resolveUserId(?int $userId): int
+    protected function resolveUserId(?string $userId): string
     {
         return $userId ?? auth()->id();
     }

src/Drivers/LaravelCartSession.php

@@ -12,7 +12,7 @@ class LaravelCartSession implements Driver
     /**
      * Store item in cart.
      */
-    public function storeItem(Model|array $item, ?int $userId = null): static
+    public function storeItem(Model|array $item, ?string $userId = null): static
     {
         $userId = $this->resolveUserId($userId);
         $cart = $this->getCart($userId);
@@ -43,7 +43,7 @@ public function storeItem(Model|array $item, ?int $userId = null): static
     /**
      * Store multiple items in cart.
      */
-    public function storeItems(array $items, ?int $userId = null): static
+    public function storeItems(array $items, ?string $userId = null): static
     {
         foreach ($items as $item) {
             $this->storeItem($item, $userId);
@@ -55,7 +55,7 @@ public function storeItems(array $items, ?int $userId = null): static
     /**
      * Increase the quantity of the item.
      */
-    public function increaseQuantity(Model $item, int $quantity = 1, ?int $userId = null): static
+    public function increaseQuantity(Model $item, int $quantity = 1, ?string $userId = null): static
     {
         $userId = $this->resolveUserId($userId);
         $cart = $this->getCart($userId);
@@ -75,7 +75,7 @@ public function increaseQuantity(Model $item, int $quantity = 1, ?int $userId =
     /**
      * Decrease the quantity of the item.
      */
-    public function decreaseQuantity(Model $item, int $quantity = 1, ?int $userId = null): static
+    public function decreaseQuantity(Model $item, int $quantity = 1, ?string $userId = null): static
     {
         $userId = $this->resolveUserId($userId);
         $cart = $this->getCart($userId);
@@ -95,7 +95,7 @@ public function decreaseQuantity(Model $item, int $quantity = 1, ?int $userId =
     /**
      * Remove a single item from the cart.
      */
-    public function removeItem(Model $item, ?int $userId = null): static
+    public function removeItem(Model $item, ?string $userId = null): static
     {
         $userId = $this->resolveUserId($userId);
         $cart = $this->getCart($userId);
@@ -109,7 +109,7 @@ public function removeItem(Model $item, ?int $userId = null): static
     /**
      * Remove every item from the cart.
      */
-    public function emptyCart(?int $userId = null): static
+    public function emptyCart(?string $userId = null): static
     {
         $userId = $this->resolveUserId($userId);
         session([$this->sessionKey($userId) => []]);
@@ -120,7 +120,7 @@ public function emptyCart(?int $userId = null): static
     /**
      * Get the cart from the session.
      */
-    protected function getCart(?int $userId = null): array
+    protected function getCart(?string $userId = null): array
     {
         $userId = $this->resolveUserId($userId);
 
@@ -130,15 +130,15 @@ protected function getCart(?int $userId = null): array
     /**
      * Resolve the session key for a user.
      */
-    protected function sessionKey(int $userId): string
+    protected function sessionKey(string $userId): string
     {
         return self::SESSION_KEY_PREFIX.$userId;
     }
 
     /**
      * Resolve the user ID, defaulting to the authenticated user.
      */
-    protected function resolveUserId(?int $userId): int
+    protected function resolveUserId(?string $userId): string
     {
         return $userId ?? auth()->id();
     }

src/LaravelCart.php

@@ -4,16 +4,16 @@
 
 /**
  * @method static \Binafy\LaravelCart\Drivers\Driver driver(string|null $driver = null)
- * @method static \Binafy\LaravelCart\Drivers\Driver storeItem(\Illuminate\Database\Eloquent\Model|array $item, int|null $userId = null)
+ * @method static \Binafy\LaravelCart\Drivers\Driver storeItem(\Illuminate\Database\Eloquent\Model|array $item, string|null $userId = null)
  * @method static \Binafy\LaravelCart\Drivers\Driver storeItems(array $items)
  * @method static \Binafy\LaravelCart\Drivers\Driver increaseQuantity(\Illuminate\Database\Eloquent\Model $item, int $quantity = 1)
  * @method static \Binafy\LaravelCart\Drivers\Driver decreaseQuantity(\Illuminate\Database\Eloquent\Model $item, int $quantity = 1)
  * @method static \Binafy\LaravelCart\Drivers\Driver removeItem(\Illuminate\Database\Eloquent\Model $item)
  * @method static \Binafy\LaravelCart\Drivers\Driver emptyCart()
- * @method static \Binafy\LaravelCart\Drivers\Driver getOption(string $option, ?int $itemId = null, ?int $userId = null)
- * @method static \Binafy\LaravelCart\Drivers\Driver getOptions(?int $itemId = null, ?int $userId = null)
- * @method static \Binafy\LaravelCart\Drivers\Driver setOption(string $key, mixed $value, ?int $itemId = null, ?int $userId = null)
- * @method static \Binafy\LaravelCart\Drivers\Driver addOption(string $key, mixed $value, ?int $itemId = null, ?int $userId = null)
+ * @method static \Binafy\LaravelCart\Drivers\Driver getOption(string $option, ?int $itemId = null, ?string $userId = null)
+ * @method static \Binafy\LaravelCart\Drivers\Driver getOptions(?int $itemId = null, ?string $userId = null)
+ * @method static \Binafy\LaravelCart\Drivers\Driver setOption(string $key, mixed $value, ?int $itemId = null, ?string $userId = null)
+ * @method static \Binafy\LaravelCart\Drivers\Driver addOption(string $key, mixed $value, ?int $itemId = null, ?string $userId = null)
  * @method static string getDefaultDriver()
  * @method static void setDefaultDriver(string $name)
  *

src/Models/Cart.php

@@ -14,11 +14,11 @@
 class Cart extends Model
 {
     /**
-     * Fillable columns.
+     * Guarded columns.
      *
-     * @var string[]
+     * @var array
      */
-    protected $fillable = ['user_id'];
+    protected $guarded = ['id'];
 
     /**
      * The relations to eager load on every query.
@@ -56,7 +56,7 @@ public function scopeFirstOrCreateWithStoreItems(
         Builder $query,
         Model $item,
         int $quantity = 1,
-        ?int $userId = null
+        ?string $userId = null
     ): Builder {
         if (is_null($userId)) {
             $userId = auth()->id();