glorand/laravel-eloquent-model-uuid

A simple solution for providing UUID support for the IDs of your Eloquent models.

4.0.0 2022-02-10 07:57 UTC

README

Latest Stable Version Build Status Software License StyleCI Code Intelligence Status Scrutinizer Code Quality Code Coverage

A simple solution for providing UUID support for the IDs of your Eloquent models.

Installation

You can install the package via composer:

composer require glorand/laravel-eloquent-model-uuid

Usage

Let us start on the database side of things.

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

Use model class provided by this package

Instead of extending the standard Laravel model class, extend from the model class provided by this package:

<?php
use Glorand\LaravelEloquentModelUuid\Database\Eloquent\Model;

class Entity extends Model
{
    //
}

Use Trait on model class:

<?php
use Illuminate\Database\Eloquent\Model;
use Glorand\LaravelEloquentModelUuid\Database\Concerns\Uuid;

class Entity extends Model
{
    use Uuid;
    
    /**
     * The "type" of the auto-incrementing ID.
     *
     * @var string
     */
    protected $keyType = 'string';

    /**
     * Indicates if the IDs are auto-incrementing.
     *
     * @var bool
     */
    public $incrementing = false;
    //
}

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email gombos.lorand@gmail.com instead of using the issue tracker.

License

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