Generate slugs when saving Eloquent models
This package provides a trait that will generate a unique uuid when saving any Eloquent model.
$model = new EloquentModel();
$model->name = 'activerecord is awesome';
$model->save();
echo $model->uuid; // outputs a uuid
Installation
You can install the package via composer:
composer require alhaji-aki/laravel-uuid
Usage
Your Eloquent models should use the AlhajiAki\LaravelUuid\HasUuid trait.
The trait contains an abstract method getUuidColumn() that you must implement yourself.
Your models' migrations should have a field to save the uuid to.
Here's an example of how to implement the trait:
namespace App;
use AlhajiAki\LaravelUuid\HasUuid;
use Illuminate\Database\Eloquent\Model;
class YourEloquentModel extends Model
{
use HasUuid;
/**
* Get the column to save the generated uuid to.
*/
public function getUuidColumn() : string
{
return 'uuid';
}
}
With its migration:
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
class CreateYourEloquentModelTable extends Migration
{
public function up()
{
Schema::create('your_eloquent_models', function (Blueprint $table) {
$table->increments('id');
$table->string('uuid'); // Field name same as what you return in `getUuidColumn`
$table->string('name');
$table->timestamps();
});
}
}
Using slugs in routes
To use the generated uuid in routes, remember to use Laravel's implicit route model binding:
namespace App;
use AlhajiAki\LaravelUuid\HasUuid;
use Illuminate\Database\Eloquent\Model;
class YourEloquentModel extends Model
{
use HasUuid;
/**
* Get the column to save the generated uuid to.
*/
public function getUuidColumn() : string
{
return 'uuid';
}
/**
* Get the route key for the model.
*
* @return string
*/
public function getRouteKeyName()
{
return 'uuid';
}
}
Overriding slugs
You can also override the generated slug just by setting it to another value than the generated slug.
$model = EloquentModel::create(['name' => 'my name']); //slug is now "my-name";
$model->slug = 'my-custom-url';
$model->save(); //slug is now "my-custom-url";
Testing
composer test
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
This package is inspired by Spatie Laravel Sluggable.
License
The MIT License (MIT). Please see License File for more information.
![[error] react-native link Package name not found in {app-folder}/android/app/src/debug/AndroidManifest.xml](https://avatars.githubusercontent.com/u/1158435?v=4)
4 Mar 1, 2022
33 Nov 6, 2022
10 Jan 20, 2022
25 Dec 14, 2022
501 Jan 4, 2023
4 May 12, 2022
7 Oct 12, 2022
859 Dec 11, 2022
15 Feb 17, 2022
240 Oct 26, 2022
11 Apr 21, 2021
30 Dec 24, 2022
138 Nov 28, 2022
10 May 17, 2022
33 Nov 4, 2022
52 Sep 6, 2022