arniro/laravel-sluggable

A package to generate a slug for Laravel models. Translatable columns are also supported.

0.1.3 2020-12-04 04:55 UTC

Requires

• illuminate/support: >=5.0

Requires (Dev)

• mockery/mockery: ^1.1
• orchestra/testbench: ~3|~4
• phpunit/phpunit: ^8.0
• sempro/phpunit-pretty-print: ^1.0
• spatie/laravel-translatable: ^4.3

MIT

• Artyom Nishchuk

• sluggable
• translatable
• laravel

README

Installation

Install the package via composer:

composer require arniro/laravel-sluggable

Usage

Include a Sluggable trait to the model:

use Arniro\Sluggable\Sluggable;
use Illuminate\Database\Eloquent\Model;

class Product extends Model
{
    use Sluggable;

    //
}

Whenever you create or update a model, a slug will be generated from the name column to the slug column by default.

Product::create([
    'name' => 'Lorem Ipsum'
]);

A slug column will be filled with the following value: lorem-ipsum. The slug value will always be unique.

You can override a column name that is used to generate a slug from with the getSluggable method:

use Arniro\Sluggable\Sluggable;
use Illuminate\Database\Eloquent\Model;

class Product extends Model
{
    use Sluggable;

    public function getSluggable()
    {
        return 'title';
    }

    //
}

Translatable columns

If your column is translatable and you use a spatie/laravel-translatable package it will be recognized and used behind the scenes so all you need to do is to add your slug column name to the translatable property of your model:

use Arniro\Sluggable\Sluggable;
use Illuminate\Database\Eloquent\Model;
use Spatie\Translatable\HasTranslations;

class Product extends Model
{
    use HasTranslations, Sluggable;

    public $translatable = ['name', 'slug'];

    //
}

So now if you're creating or updating a sluggable column, all of its locales will be slugged:

$product = Product::create([
    'name' => [
        'en' => 'Lorem Ipsum',
        'ru' => 'Lorem Ipsum Ru'
    ]
]);
$product->getTranslations('slug'); // ['en' => 'lorem-ipsum','ru' => 'lorem-ipsum-ru']

Testing

composer test

License

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