cleaniquecoders/laravel-uuid

Use UUID for your Laravel application.

3.1.0 2023-02-25 03:31 UTC

Requires

• php: ^8.0|^8.1|^8.2
• doctrine/dbal: ^3.6
• illuminate/auth: ^9.0|^10.0
• illuminate/support: ^9.0|^10.0

Requires (Dev)

• laravel/pint: ^1.6
• orchestra/testbench: 7.*|8.*
• pestphp/pest: ^2.0
• phpstan/phpstan-phpunit: ^1.0

MIT

• Nasrul Hazim

• package
• uuid
• laravel

README

Laravel Uuid

This package allows you to use UUID as primary key.

Installation

In order to install cleaniquecoders/laravel-uuid in your Laravel project, just run the composer require command from your terminal:

$ composer require cleaniquecoders/laravel-uuid

Usage

First, you need to define in your migration the uuid field you want to use:

$table->uuid('uuid')->default('-');

Configure your model to include \CleaniqueCoders\LaravelUuid\Traits HasUuid trait and implement \CleaniqueCoders\LaravelUuid\Contracts\HasUuid contract.

use Illuminate\Database\Eloquent\Model;
use CleaniqueCoders\LaravelUuid\Contracts\HasUuid as HasUuidContract;
use CleaniqueCoders\LaravelUuid\Traits\HasUuid;

class User extends Model implements HasUuidContract
{
    use HasUuid;
}

By using the trait, you are able to use uuid($uuid) scope. Additional setup, you may want to define protected $uuid_column = 'user_uuid' if you have different UUID column name.

$user = User::uuid($uuid)->first();

Next, you can use \CleaniqueCoders\LaravelUuid\Observers\UuidObserver to automatically set the uuid value for you before save into database. You need to register in the App\Providers\AppServiceProvider in boot method:

use CleaniqueCoders\LaravelUuid\Observers\UuidObserver;
use App\User;
...
public function boot()
{
    User::observe(UuidObserver::class);
}

Alternatively, you can utilise the Laravel Observer package.

Test

Run the following command:

$ vendor/bin/phpunit  --testdox --verbose

Contributing

Thank you for considering contributing to the cleaniquecoders/laravel-uuid!

Bug Reports

To encourage active collaboration, it is strongly encourages pull requests, not just bug reports. "Bug reports" may also be sent in the form of a pull request containing a failing test.

However, if you file a bug report, your issue should contain a title and a clear description of the issue. You should also include as much relevant information as possible and a code sample that demonstrates the issue. The goal of a bug report is to make it easy for yourself - and others - to replicate the bug and develop a fix.

Remember, bug reports are created in the hope that others with the same problem will be able to collaborate with you on solving it. Do not expect that the bug report will automatically see any activity or that others will jump to fix it. Creating a bug report serves to help yourself and others start on the path of fixing the problem.

Coding Style

cleaniquecoders/laravel-uuid follows the PSR-2 coding standard and the PSR-4 autoloading standard.

You may use PHP CS Fixer in order to keep things standardised. PHP CS Fixer configuration can be found in .php_cs.

License

This package is open-sourced software licensed under the MIT license.