sjousse/laravel-unique-reference

Create unique reference for Eloquent models in Laravel.

1.0 2016-06-21 14:23 UTC

Requires

• php: >=5.4.0
• illuminate/database: >=4.0
• illuminate/support: >=4.0

MIT

• Sébastien Jousse

• Reference
• laravel
• eloquent
• unique

README

This is a simple trait for Laravel models to generate unique reference for them. It's configurable within the model itself.

Installation

You may install this package via composer:

$ composer require sjousse/laravel-unique-reference

Usage

To start generating references for your models, all you need to do is use a trait, like so:

namespace App;

use Illuminate\Database\Eloquent\Model;
use SJousse\UniqueReference\UniqueReference;

class YourModel extends Model
{
    use UniqueReference;

    // The rest of your model
}

By default, this package assumes you have a reference column on you database to store the unique 10 characters reference in. Optionally, you may override this by setting properties $referenceField and $referenceLength in your model:

namespace App;

use Illuminate\Database\Eloquent\Model;
use SJousse\UniqueReference\UniqueReference;

class YourModel extends Model
{
    use GeneratesUnique;

    var $referenceField = 'reference'; // this will assume 'reference' by default.
    var $referenceLength = 10; // this will assume '10' by default.

    // The rest of your model
}

Credits

This package was inspired by svenluijten's package, found here.

License

Licensed under the MIT Licence.