halfpetal/laravel-identifiable

A simple way to create identifiers for Laravel models.

v1.0.1 2018-02-10 07:37 UTC

Requires

• php: >=5.4.0

Requires (Dev)

• codeclimate/php-test-reporter: ^0.3.2
• doctrine/dbal: ^2.5
• fzaninotto/faker: ~1.4
• laravel/laravel: 5.*
• mockery/mockery: ^0.9.5
• phpunit/phpunit: 5.*

MIT

• id
• laravel
• models

README

Supported Versions

Laravel Version	Tested	Working
v5.6	✔️	✔️
v5.5	✔️	✔️

About

Laravel Identifiable is a package that allows you to add an Identifiable trait to any model and will create unique identifiers for it. It also provides automatic route-key binding with the identifier system.

Installation

composer require halfpetal/laravel-identifiable

If you use Laravel 5.5+, you have nothing else to do. If not, add our service provider to config/app.php

'providers' => [
    ...
    Halfpetal\Laravel\Identifiable\IdentifiableServiceProdiver::class,
    ...
];

Once that is done, just publish the migrations!

php artisan vendor:publish --provider="Halfpetal\Laravel\Identifiable\IdentifiableServiceProdiver" --tag="migrations"

Then you migrate when ready.

php artisan migrate

Setting Up Models

It's simple, just add the Identifiable trait to the model you want to use the identifier system on.

use Halfpetal\Laravel\Identifiable\Traits\Identifiable;

class User extends Model
{
  use Identifiable;
  ...
}

How to Use

You don't need to know how to do anything! It just works right out of the box. Instead of exposing the model's id, it will now show the unique identifier generated for it.

Customization/Configuration

Identifier Length

If you would like to set different identifier length you can do that by adding the following to your model:

protected static $idLength = 12; // This will generate identifiers with a length of 12 characters

Disable Auto-generation of Identifiers

If for some strange reason you would like to have more control over the process (and in turn also breaking route binding functionality if you don't generate the identifiers) you can do that by setting the following variable:

protected static $idAutoGenerate = false;

This can be helpful in some cases where you want to allow custom identifiers; just remember though that each identifier must be unique to the model.

Unique Identifiers

Each identifier is unique based off of the type and the value. So for example...you have a comment and a post both with the same slug...

Value	Type
wow-amazing	App\Post	✔️
wow-amazing	App\Comment	✔️
wow-amazing	App\Post	✖️

The third one fails because it's not unique to App\Post. However, if it were say App\Video, or something else, it would work just fine.