jenbuzz/laravel-uuid

Adds a uuid to a model using ramsey/uuid

, _(*1)

Laravel UUID

This package easily adds a uuid generated with ramsey/uuid to an Eloquent model., _(*2)

Installation

composer require jenbuzz/laravel-uuid, _(*3)

Documentation

To automatically create a uuid for new models all that is needed is to include the uuid trait as in the following example:, _(*4)

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Jenbuzz\LaravelUuid\Traits\Uuid;

class MyModel extends Model
{
    use Uuid;
}

There are several options to specify the uuid that should be generated: 'uuidVersion', 'uuidString', 'uuidColumnName', and 'uuidGenerateOnSave'. But first..., _(*5)

Default values are: - uuidVersion = 4 - uuidString = '' - uuidColumnName = 'uuid' - uuidGenerateOnSave = false, _(*6)

The last option, 'uuidGenerateOnSave', will generate a uuid for the element on the next save action if set to true. This could be useful if uuids were introduced later on and existing elements require an uuid., _(*7)

To change these options they can be specified through class properties in the model as in the following example:, _(*8)

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Jenbuzz\LaravelUuid\Traits\Uuid;

class MyModel extends Model
{
    use Uuid;

    protected $uuidVersion = 5;
    protected $uuidString = 'lorem';
    protected $uuidColumnName = 'my_uuid';
    protected $uuidGenerateOnSave = true;
}

The uuid trait also adds a 'find'-function to the model which makes it is easy to find an element by uuid. This can be done as in the following code snippet:, _(*9)

<?php

$element = MyModel::findByUuid('3059dbe0-20d4-4591-9b02-1f77a1826544');

License

This package is open-sourced software licensed under the MIT license, _(*10)