Wallogit.com
2017 © Pedro Peláez
Automatically add slugs to eloquent models
Using Composer, (*1)
$ composer require taylornetwork/model-slugger
In a class that extends Illuminate\Database\Eloquent\Model add the TaylorNetwork\ModelSlugger\ModelSlugger trait., (*2)
This will require you to define the sluggerConfig() function which returns an array with minimum options being ['source' => 'model field to make slug from'], (*3)
// app/ExampleModel.php
namespace App;
use Illuminate\Database\Eloquent\Model;
use TaylorNetwork\ModelSlugger\ModelSlugger;
class ExampleModel extends Model
{
use ModelSlugger;
public function sluggerConfig()
{
return [
'source' => 'name',
];
}
}
Where name would be converted to a slug and placed into the column slug by default, (*4)
You can bind the routes in your application to the slug rather than ID by adding, (*5)
protected $sluggerRouteModelBind = true;
To your model, it will cause the routes to be looked up using the slug column., (*6)
To make all slugs unique add 'unique' => 'all' to the config array either in the model or in config/slugger.php, (*7)
// app/ExampleModel.php
public function sluggerConfig()
{
return [
'source' => 'name',
'unique' => 'all',
];
}
If you want slugs to only be unique based on a parent class, add 'unique' => 'parent', 'parent' => 'App\ParentClassName' to the model or config/slugger.php, (*8)
For example you have a App\User model and a App\TodoList model where the a user can have many todo lists each with slugs. If we set the config to unique => all and every user makes a todo list named 'my todo list' the slugs will become increasingly long as they become unique., (*9)
To avoid this you can make the slugs unique if they are from the same parent., (*10)
// app/TodoList.php
public function sluggerConfig()
{
return [
'source' => 'name',
'unique' => 'parent',
'parent' => 'App\User',
];
}
To accomplish route model binding you will need to add the code to find only slugs with the correct parent to your App\Providers\RouteServiceProvider class, (*11)
For example, (*12)
public function boot()
{
Route::bind('user', function ($value) {
return App\User::findOrFail($value); // Code to find by ID or slug
});
Route::bind('todoList', function ($slug, $route) {
// $route->parameter('user') will return an instance of App\User
return $route->parameter('user')->todoLists()->where('slug', $slug)->firstOrFail();
});
parent::boot();
}
The MIT License (MIT). Please see License File for more information., (*13)
Automatically add slugs to eloquent models
Automatically add slugs to eloquent models
Automatically add slugs to eloquent models