Merge pull request #13 from verbanent/hotfix/uuid-column-name

Added UUID column name

Author: radek-ziemniewicz

README.md

@@ -67,8 +67,7 @@ class Book extends Model
 {
     use BinaryUuidSupportableTrait;
 
-    protected $primaryKey = 'uuid';
-    protected $fillable = ['uuid'];
+    public $uuidColumn = 'uuid';
 }
 ```
 
@@ -92,6 +91,7 @@ use Verbanent\Uuid\AbstractModel;
 
 class Lang extends AbstractModel
 {
+    public $uuidColumn = 'uuid';
     protected $primaryKey = 'uuid';
     protected $fillable = ['uuid'];
 }

src/AbstractModel.php

@@ -14,6 +14,8 @@ class AbstractModel extends Model
 {
     use BinaryUuidSupportableTrait;
 
+    public const DEFAULT_UUID_COLUMN = 'id';
+
     /**
      * Disable incrementing of ID column.
      *

src/Traits/BinaryUuidSupportableTrait.php

@@ -8,6 +8,7 @@
 use Illuminate\Database\Eloquent\Model;
 use Ramsey\Uuid\Codec\OrderedTimeCodec;
 use Ramsey\Uuid\Uuid;
+use Verbanent\Uuid\AbstractModel;
 use Verbanent\Uuid\Exceptions\AccessedUnsetUuidPropertyException;
 
 /**
@@ -61,7 +62,7 @@ public static function bootBinaryUuidSupportableTrait(): void
     {
         static::creating(
             function (Model $model) {
-                $uuid = $model->getKeyName();
+                $uuid = $model->getUuidColumn();
 
                 /** @var Model|BinaryUuidSupportableTrait $model */
                 if (!isset($model->attributes[$uuid])) {
@@ -103,7 +104,7 @@ public function generateUuid(): string
      */
     public function uuid(): string
     {
-        $uuid = $this->getKeyName();
+        $uuid = $this->getUuidColumn();
 
         if (!isset($this->$uuid)) {
             throw new AccessedUnsetUuidPropertyException(
@@ -114,6 +115,16 @@ public function uuid(): string
         return Uuid::fromBytes($this->$uuid)->toString();
     }
 
+    /**
+     * Return primary UUID column.
+     *
+     * @return string
+     */
+    public function getUuidColumn(): string
+    {
+        return $this->uuidColumn ?? AbstractModel::DEFAULT_UUID_COLUMN;
+    }
+
     /**
      * Returns model by its UUID or fails.
      *
@@ -123,7 +134,7 @@ public function uuid(): string
      */
     public static function find(string $uuid): Model
     {
-        $uuidKey = app(static::class)->getKeyName();
+        $uuidKey = app(static::class)->getUuidColumn();
 
         return static::where($uuidKey, '=', Uuid::fromString($uuid)->getBytes())->firstOrFail();
     }

tests/Example/AbstractExampleUuidModel.php

@@ -25,6 +25,13 @@ class AbstractExampleUuidModel extends AbstractModel
      */
     public $timestamps = false;
 
+    /**
+     * The UUID column name.
+     *
+     * @var string
+     */
+    public $uuidColumn = 'uuid';
+
     /**
      * Column name for primary key.
      *