You can install the package via composer:
composer require ryangjchandler/laravel-uuidThere are 2 methods for applying automatic UUID generation to your models:
Add the RyanChandler\Uuid\Concerns\HasUuid trait to your model:
class Post extends Model
{
use \RyanChandler\Uuid\Concerns\HasUuid;
}This will automatically assign a time-ordered UUID to the uuid column on your model. UUIDs are generated using the Str::orderedUuid() method provided by Laravel.
If you wish to change the column that is used, you can define a uuidColumn method on your model:
class Post extends Model
{
use \RyanChandler\Uuid\Concerns\HasUuid;
public function uuidColumn(): string
{
return 'guid';
}
}You can use the Model::findByUuid and Model::findByUuidOrFail methods to quickly retrieve a model from it's UUID. These behave the same way as Model::find and Model::findOrFail.
If you want to use the defaults and would like to avoid adding more traits to your model, you can mass-register your models in the boot method of a ServiceProvider.
use RyanChandler\Uuid\Uuid;
class AppServiceProvider extends ServiceProvider
{
public function boot()
{
Uuid::generateFor([
\App\Models\Post::class,
]);
}
}If you want to use your uuid column as the default route-model binding column, you can implement the RyanChandler\Uuid\Contracts\WithUuidRouteKey contract on your model.
This will force the HasUuid trait to use the uuid column as the return value of getRouteKeyName which Laravel uses to determine how to receive a model for implicit route-model binding.
composer testPlease see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.