binarycabin/laravel-uuid

A wrapper for webpatser/laravel-uuid with additional integration

1.0.2 2019-03-08 03:06 UTC

This package is auto-updated.

Last update: 2020-03-22 18:14:54 UTC


README

Build Status StyleCI Latest Stable Version Total Downloads

A wrapper for webpatser/laravel-uuid with additional integration

composer require binarycabin/laravel-uuid

This package adds a very simple trait to automatically generate a UUID for your Models.

Simply add the "\BinaryCabin\LaravelUUID\Traits\HasUUID;" trait to your model:

<?php

namespace App;

use BinaryCabin\LaravelUUID\Traits\HasUUID;
use Illuminate\Database\Eloquent\Model;

class Project extends Model
{

    use HasUUID;

}

If your column name is not "uuid", simply add a new property to your model named "uuidFieldName":

protected $uuidFieldName = 'unique_id';

This trait also adds a scope:

\App\Project::byUUID('uuid')->first();

And static find method:

\App\Project::findByUUID('uuid')

A second trait is available if you use your UUIDs as primary keys:

<?php

namespace App;

use BinaryCabin\LaravelUUID\Traits\HasUUID;
use BinaryCabin\LaravelUUID\Traits\UUIDIsPrimaryKey;
use Illuminate\Database\Eloquent\Model;

class Project extends Model
{

    use HasUUID, UUIDIsPrimaryKey;

}

It simply tells Laravel that your primary key isn't an auto-incrementing integer, so it will treat the value correctly.