README

A professional, robust, and transaction-safe auto-slug generation package for Laravel Eloquent models. Automatically generates clean, SEO-friendly, and unique slugs with comprehensive duplicate prevention.

Features

🚀 Auto-generate SEO-friendly slugs - Clean, readable URLs automatically
🔒 Transaction-safe - Prevents race conditions with database transactions
🔄 Update-aware - Regenerates slugs when source fields change
🎯 Fully customizable - Configure slug fields, source fields, and separators
🛡️ Duplicate prevention - Automatically handles slug conflicts
📦 PSR-4 compliant - Professional code standards
🧪 Full test coverage - Reliable and well-tested
🔧 Laravel 10 & 11 - Full framework support

Installation

composer require sharifuddin/laravel-smart-auto-slug
---

## ⚡ Installation

Install via Composer:

```bash
composer require sharifuddin/laravel-smart-auto-slug

If you want, you can also publish the service provider, but the package supports auto-discovery.

🛠 Usage

1. Basic Usage

use Illuminate\Database\Eloquent\Model;
use Sharifuddin\LaravelSmartAutoSlug\Traits\SmartAutoSlug;

class Post extends Model
{
use SmartAutoSlug;

    protected $fillable = ['title', 'content'];

}

2. Custom Configuration

class Post extends Model
{
    use SmartAutoSlug;

    protected $slugField = 'url_slug'; // Default: 'slug'
    protected $slugSourceField = 'title'; // Default: 'name'

    protected $fillable = ['title', 'content', 'url_slug'];
}

Examples

// Creating posts with automatic slugs
$post1 = Post::create(['title' => 'My First Post']);
echo $post1->slug; // Output: "my-first-post"

$post2 = Post::create(['title' => 'My First Post']);
echo $post2->slug; // Output: "my-first-post-1"

// Slugs update when titles change
$post1->update(['title' => 'Updated Post Title']);
echo $post1->slug; // Output: "updated-post-title"

Manual Slug Regeneration

$post = Post::find(1);
$post->title = 'Completely New Title';
$post->regenerateSlug(); // Manually regenerate slug
$post->save();

🔧 Customization

Publish the configuration file:

php artisan vendor:publish --tag=smart-auto-slug-config

Property	Default	Description
`$slugField`	`slug`	The database column where the slug is stored.
`$slugSourceField`	`name`	The model field used to generate the slug.

The trait ensures uniqueness by checking existing slugs and appending a numeric suffix if necessary.

⚙️ Requirements

Compatibility

Laravel Version	PHP Version	Package Version
12.x	8.2+	^1.0
11.x	8.2+	^1.0
10.x	8.1+	^1.0
9.x	8.0+	^1.0
8.x	8.0+	^1.0

🧪 Testing

Run the package tests using PHPUnit:

vendor/bin/phpunit

Run code analysis with PHPStan:

vendor/bin/phpstan analyse

📜 License

This package is open-sourced software licensed under the MIT license.

👨‍💻 Author

Sharif Uddin

Email: sharif.webpro@gmail.com
Website: https://sharifwebdev.github.io/

sharifuddin / laravel-smart-auto-slug

Maintainers

Details