kblais/laravel-uuid

A simple library to use UUIDs as your Eloquent model's primary key.

v2.2.0 2024-04-16 12:11 UTC

Requires

• php: ^8.0
• illuminate/database: ^9.33.0|^10.0|^11.0
• ramsey/uuid: ^3.4|^4.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.5
• larastan/larastan: ^2.9
• mockery/mockery: ^1.3.2
• orchestra/testbench: ^6.23|^7.0|^8.0|^9.0

MIT

• Killian Blais

README

A simple library to use UUIDs as your Eloquent model's primary key.

Why should I use UUIDs ?

To answer this question, I simply recommend you read this blog post.

OK, I'm convinced now. How do I install this ?

Require this package with Composer :

composer require kblais/laravel-uuid

• the package internally use ramsey/uuid to generate the UUIDs.

Usage

First, your model's column must be a 36 characters column :

• Laravel v4

$table->char('id', 36);
$table->primary('id');

• Laravel v5+

$table->uuid('id');
$table->primary('id');

Then, just add the Kblais\Uuid\Uuid trait to your model, and you're done :

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Kblais\Uuid\Uuid;

class User extends Model
{
    use Uuid;
}

Version 4 UUIDs are used by default. You can change this by overriding the $uuidVersion & $uuidString variables. For example :

protected $uuidVersion = 1;
protected $uuidString  = ''; // only needed when $uuidVersion is "3 or 5"

The supported UUIDs versions here are "1, 3, 4 and 5".