macsidigital/laravel-uuid

Laravel UUID package

4.0.0 2024-05-11 09:28 UTC

This package is auto-updated.

Last update: 2024-05-11 09:34:18 UTC


README

UUID's on Laravel models

Header Image

tests badge version badge downloads badge

Laravel UUID, a UUID helper Library

Support us

We invest a lot in creating open source packages, and would be grateful for a sponsor if you make money from your product that uses them.

Installation

This package can be used in Laravel 10.0 or higher with PHP 8.0 and higher. There are older versions which go back to PHP7.4 and Laravel 6.

You can install the package via composer:

composer require macsidigital/laravel-uuid

Usage

This is quite a simple package, which can be used to override the primary key to uuid, or to add an additional uuid field, our preferred option to keep an incrementing index.

Add a uuid field

	// primary key implementation
    $table->uuid('id')->primary();
    
    // or implementation for additional field

    $table->uuid('uuid');  

});

Add the trait to get automatic UUID generation

namespace App\Models;
use Uuid\Traits\GeneratesUuid;

class FakeModel extends Model
{

use GeneratesUuid;

}

That's it! unless we use a different column name for the uuid field, then we add the following method.

	 public function uuidColumn(): string
    {
        return 'id';
    }
});

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security-related issues, please email info@macsi.co.uk instead of using the issue tracker.

Credits

License

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