Laravel Model UUID
A simple package to generate model uuid for laravel models
Installation
Require the package using composer:
composer require touhidurabir/laravel-model-uuid
To publish the config file:
php artisan vendor:publish --provider="Touhidurabir\ModelUuid\ModelUuidServiceProvider" --tag=config
Usage
Use the trait HashUuid in model where uuid needed to attach
use Touhidurabir\ModelUuid\HasUuid;
use Illuminate\Database\Eloquent\Model;
class User extends Model {
use HasUuid;
}
By default this package use the column name uuid as for the uuid attach and preform it on model creating event . But these configurations can be changed form the model-uuid.php config file.
Also possible to override the uuid column and attaching event from each of the model . to do that need to place the following method in the model :
use Touhidurabir\ModelUuid\HasUuid;
use Illuminate\Database\Eloquent\Model;
class User extends Model {
use HasUuid;
public function uuidable() : array {
return [
'column' => 'uuid',
'event' => 'created',
];
}
}
Make sure to the put the uuid colun name in migration file
$table->string('uuid')->nullable()->unique()->index();
Or can be used with the combination of model-uuid config as such:
$table->string(config('model-uuid.column'))->nullable()->unique()->index();
This package also include some helper method that make it easy to find model records via UUID. for example
User::byUuid($uuid)->where('active', true)->first(); // single uuid
User::byUuid([$uuid1, $uuid2])->where('active', true)->get(); // multiple uuid
Or simple and direct find
User::findByUuid($uuid); // single uuid
User::findByUuid([$uuid1, $uuid2]); // multiple uuid
The package also provide a bit of safe guard by checking if the model table has the given uuid column .
If the uuid column not found for model table schema, it will not create and attach an uuid.
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
15 Oct 29, 2022
49 Jun 22, 2022
372 Dec 27, 2022
3 Feb 10, 2022
52 Jul 17, 2022
4 May 12, 2022
5 Jan 6, 2023
27 Mar 2, 2022
13 Mar 2, 2022
2 Oct 14, 2021
4 Mar 1, 2022
10 May 17, 2022
66 Sep 19, 2022
33 Nov 4, 2022
25 Dec 14, 2022
501 Jan 4, 2023
87 Nov 26, 2022