README

Generate slugs when saving Eloquent models

This package was created by Spatie. We have forked it so we can add new features we need and so we are not dependend on Spatie before we can upgrade to new Laravel versions.

$model = new EloquentModel();
$model->name = 'activerecord is awesome';
$model->save();

echo $model->slug; // ouputs "activerecord-is-awesome"

The slugs are generated with Laravels Str::slug method, whereby spaces are converted to '-'.

Installation

You can install the package via composer:

composer require marshmallow/sluggable

The package registers its Marshmallow\Sluggable\SluggableServiceProvider automatically through Laravel's package discovery, so there is nothing else to wire up.

Usage

Your Eloquent models should use the Marshmallow\Sluggable\HasSlug trait and the Marshmallow\Sluggable\SlugOptions class.

The trait contains an abstract method getSlugOptions() that you must implement yourself.

Your models' migrations should have a field to save the generated slug to.

Here's an example of how to implement the trait:

namespace App;

use Marshmallow\Sluggable\HasSlug;
use Marshmallow\Sluggable\SlugOptions;
use Illuminate\Database\Eloquent\Model;

class YourEloquentModel extends Model
{
    use HasSlug;

    /**
     * Get the options for generating the slug.
     */
    public function getSlugOptions() : SlugOptions
    {
        return SlugOptions::create()
            ->generateSlugsFrom('name')
            ->saveSlugsTo('slug');
    }
}

With its migration:

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

class CreateYourEloquentModelTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('your_eloquent_models', function (Blueprint $table) {
            $table->increments('id');
            $table->string('slug'); // Field name same as your `saveSlugsTo`
            $table->string('name');
            $table->timestamps();
        });
    }
}

To use the generated slug in routes, remember to use Laravel's implicit route model binding:

namespace App;

use Marshmallow\Sluggable\HasSlug;
use Marshmallow\Sluggable\SlugOptions;
use Illuminate\Database\Eloquent\Model;

class YourEloquentModel extends Model
{
    use HasSlug;

    /**
     * Get the options for generating the slug.
     */
    public function getSlugOptions() : SlugOptions
    {
        return SlugOptions::create()
            ->generateSlugsFrom('name')
            ->saveSlugsTo('slug');
    }

    /**
     * Get the route key for the model.
     *
     * @return string
     */
    public function getRouteKeyName()
    {
        return 'slug';
    }
}

Want to use multiple field as the basis for a slug? No problem!

public function getSlugOptions() : SlugOptions
{
    return SlugOptions::create()
        ->generateSlugsFrom(['first_name', 'last_name'])
        ->saveSlugsTo('slug');
}

You can also pass a callable to generateSlugsFrom.

By default the package will generate unique slugs by appending '-' and a number, to a slug that already exists.

You can disable this behaviour by calling allowDuplicateSlugs.

public function getSlugOptions() : SlugOptions
{
    return SlugOptions::create()
        ->generateSlugsFrom('name')
        ->saveSlugsTo('slug')
        ->allowDuplicateSlugs();
}

You can also put a maximum size limit on the created slug:

public function getSlugOptions() : SlugOptions
{
    return SlugOptions::create()
        ->generateSlugsFrom('name')
        ->saveSlugsTo('slug')
        ->slugsShouldBeNoLongerThan(50);
}

The slug may be slightly longer than the value specified, due to the suffix which is added to make it unique. When no maximum is set, slugs are capped at 250 characters by default.

You can also use a custom separator by calling usingSeparator

public function getSlugOptions() : SlugOptions
{
    return SlugOptions::create()
        ->generateSlugsFrom('name')
        ->saveSlugsTo('slug')
        ->usingSeparator('_');
}

To set the language used by Str::slug you may call usingLanguage

public function getSlugOptions() : SlugOptions
{
    return SlugOptions::create()
        ->generateSlugsFrom('name')
        ->saveSlugsTo('slug')
        ->usingLanguage('nl');
}

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";

If you don't want to create the slug when the model is initially created you can set use the doNotGenerateSlugsOnCreate() function.

public function getSlugOptions() : SlugOptions
{
    return SlugOptions::create()
        ->generateSlugsFrom('name')
        ->saveSlugsTo('slug')
        ->doNotGenerateSlugsOnCreate();
}

Similarly, if you want the slug to be generated again on model updates, call generateSlugsOnUpdate().

public function getSlugOptions() : SlugOptions
{
    return SlugOptions::create()
        ->generateSlugsFrom('name')
        ->saveSlugsTo('slug')
        ->generateSlugsOnUpdate();
}

This can be helpful for creating permalinks that don't change until you explicitly want it to.

$model = EloquentModel:create(['name' => 'my name']); //slug is now "my-name";
$model->save();

$model->name = 'changed name';
$model->save(); //slug stays "my-name"

If you want to explicitly update the slug on the model you can call generateSlug() on your model at any time to make the slug according to your other options. Don't forget to save() the model to persist the update to your database.

Translatable slugs

If you generate localized routes, let your model implement the Marshmallow\Sluggable\Contracts\TranslatableSlug contract. When a model implements this contract and no explicit language has been set on the slug options, the package falls back to the locale returned by request()->getTranslatableLocale() when calling Str::slug.

use Marshmallow\Sluggable\HasSlug;
use Marshmallow\Sluggable\SlugOptions;
use Illuminate\Database\Eloquent\Model;
use Marshmallow\Sluggable\Contracts\TranslatableSlug;

class YourEloquentModel extends Model implements TranslatableSlug
{
    use HasSlug;

    public function getSlugOptions(): SlugOptions
    {
        return SlugOptions::create()
            ->generateSlugsFrom('name')
            ->saveSlugsTo('slug');
    }
}

You can also seed the available locales up front with SlugOptions::createWithLocales([...]).

Events

Whenever a slug is created, changed or removed the package dispatches an event (after the database transaction has committed):

Event	Dispatched when
`Marshmallow\Sluggable\Events\SlugWasCreated`	A model with a slug is created.
`Marshmallow\Sluggable\Events\SlugHasBeenChanged`	An existing model's slug field changes on update.
`Marshmallow\Sluggable\Events\SlugWasDeleted`	A model with a slug is deleted.

Each event exposes the affected model through its public $model property.

Out of the box these events are handled by Marshmallow\Sluggable\Listeners\RunArtisanCommands, which refreshes cached routes so slug-based URLs stay in sync. By default it runs route:clear and route:cache, but only when the application's routes are actually cached. You can customize this per model:

Override getArtisanCommands(): array to change which commands run.
Override runArtisanCommandsWhen(): bool to control when they run (defaults to app()->routesAreCached()).
Define a runSluggableArtisanCommands() method to take over the behaviour entirely.

Redirects

If your model is also redirectable (it exposes a redirectable() relation, e.g. via the marshmallow/redirectable package), the package will automatically register a redirect from the old slug to the new one whenever the slug changes, and remove those redirects when the model is deleted.

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Security

If you discover any security related issues, please email stef@marshmallow.dev instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

marshmallow / sluggable

Maintainers

Package info

Statistics

Security

README

Generate slugs when saving Eloquent models

Installation

Usage

Translatable slugs

Events

Redirects

Testing

Changelog

Security

Credits

License