yark/yark-uuid-model

A helper package for UUID enabled models in Laravel

1.0.0 2020-05-18 00:18 UTC

This package is auto-updated.

Last update: 2025-06-18 12:16:00 UTC


README

A simple trait to provide UUID support on Eloquent models.

Installation

composer require yark/yark-uuid-model

Usage

To use this in a model, add the HasUuid trait

<?php

namespace App;
use YarkHQ\LaravelUuidModel\HasUuid;

class Book extends Eloquent
{
    use HasUuid;
}

In the default configuration, a UUID will be persisted when creating a model in the UUID column. To change the column, override the $uuidColumn property.

<?php

namespace App;
use YarkHQ\LaravelUuidModel\HasUuid;

class Book extends Eloquent
{
    use HasUuid;
    protected $uuidColumn = 'uuid_key';
}

Route keys will also be set automatically so you can create a route and use UUIDs. If you want to change this then override the $routeKeyName property in your model.

<?php

namespace App;
use YarkHQ\LaravelUuidModel\HasUuid;

class Book extends Eloquent
{
    use HasUuid;
    protected $routeKeyName = 'slug';
}

License

Licensed under the MIT license