Download the PHP package gorankrgovic/laravel-shortable without Composer

Laravel Eloquent Shortable

Easy creation of short random unique ID's like Youtube ones (i.e. watch?v=e3H73n7U) for your Eloquent models in Laravel/Lumen.

Installation

Install the package via Composer:

The package will automatically register its service provider.

Optionally, publish the configuration file if you want to change any defaults:

Updating your Eloquent Models

Your models should use the Shortable trait, which has an abstract method shortable() that you need to define. This is where any model-specific configuration is set (see Configuration below for details):

If you want more than one field, you can just add more to array.

Of course, your model and database will need a column in which to store the short ID. You will need to add the column manually via your own migration.

That's it ... your model is now "shortable"!

Usage

Saving a model is easy:

And so is retrieving the shortable:

Or whatever you have called it.

The ShortService Class

All the logic to generate slugs is handled by the \Gorankrgovic\LaravelShortable\Services\ShortService class.

Generally, you don't need to access this class directly, although there is one static method that can be used to generate a short without actually creating or saving an associated model.

This would be useful for testing the package.

You can also pass an optional array of configuration values as the fourth argument.

Events

Package will fire two Eloquent model events: "shorting" and "shorted".

You can hook into either of these events just like any other Eloquent model event:

Additional trait

Adding the optional ShortableScopeHelpers trait to your model allows you to work with models and their id's. For example:

Because models can have more than one short id, this requires a bit more configuration.