astrotomic/laravel-eloquent-uuid

A simple drop-in solution for UUID support in your Eloquent models.

1.3.0 2020-09-14 10:25 UTC

This package is auto-updated.

Last update: 2020-10-14 10:36:57 UTC


README

Latest Version MIT License Offset Earth Larabelles

GitHub Workflow Status StyleCI Total Downloads

A simple drop-in solution for UUID support in your Eloquent models.

Installation

You can install the package via composer:

composer require astrotomic/laravel-eloquent-uuid

Usage

You can use the provided UsesUUID trait to add an UUID attribute in addition to your normal primary key or use it as the primary key.

Model

This will add an uuid attribute and auto-fill it before the model is created.

use Illuminate\Database\Eloquent\Model;
use App\Models\Concerns\UsesUUID;

class Post extends Model
{
    use UsesUUID;
}

If you want to customize the attribute name you can define a $uuidName property or override the getUuidName() method.

use Illuminate\Database\Eloquent\Model;
use App\Models\Concerns\UsesUUID;

class Post extends Model
{
    use UsesUUID;

    protected $uuidName = 'token';
}

And for sure you can use this trait to define your model primary key.

use Illuminate\Database\Eloquent\Model;
use App\Models\Concerns\UsesUUID;

class Post extends Model
{
    use UsesUUID;

    public $incrementing = false;

    protected $keyType = 'string';

    public function getUuidName(): string
    {
        return $this->getKeyName();
    }
}

Migration

Laravel provides an uuid() column type on the table Blueprint class.

use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;

Schema::create('posts', function (Blueprint $table) {
    // ...
    $table->uuid('uuid')->unique();
    // ...
});

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details. You could also be interested in CODE OF CONDUCT.

Security

If you discover any security related issues, please check SECURITY for steps to report it.

Credits

Alternatives

License

The MIT License (MIT). Please see License File for more information.

Treeware

You're free to use this package, but if it makes it to your production environment I would highly appreciate you buying the world a tree.

It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you contribute to my forest you’ll be creating employment for local families and restoring wildlife habitats.

You can buy trees at offset.earth/treeware

Read more about Treeware at treeware.earth