https://github.com/devboyarif/laravel-unique-slug-generator
A simple unique slug generator for the Laravel applications
https://github.com/devboyarif/laravel-unique-slug-generator
Last synced: over 1 year ago
JSON representation
A simple unique slug generator for the Laravel applications
- Host: GitHub
- URL: https://github.com/devboyarif/laravel-unique-slug-generator
- Owner: devboyarif
- Created: 2023-01-17T15:35:04.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-26T16:07:44.000Z (over 3 years ago)
- Last Synced: 2025-01-13T23:28:31.032Z (over 1 year ago)
- Language: PHP
- Homepage:
- Size: 10.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# laravel-unique-slug-generator
A simple unique slug generator for the Laravel applications
---
## Installation
```sh
composer require devboyarif/laravel-unique-slug
```
## Configuration
**Service Provider Registration**
In `config/app.php`, add in `providers` array -
```php
'providers' => [
// ...
Devboyarif\LaravelUniqueSlug\UniqueSlugServiceProvider::class,
// ...
],
```
**Facade Class Alias**
Add in aliases array -
```php
'aliases' => Facade::defaultAliases()->merge([
// ...
'UniqueSlug' => Devboyarif\LaravelUniqueSlug\Facades\UniqueSlug::class,
// ...
])->toArray(),
```
## Use from Controller
#### Import first the UniqueSlug facade
```php
use Devboyarif\LaravelUniqueSlug\Facades\UniqueSlug;
```
### Example #01- Post unique slug from title
Let's assume, we have in `Post` class, we've added `slug` column which is unique. Now, if we passed `title` and generate `slug` from that, then -
```php
use App\Models\Post;
// First time create post with title Simple Post
UniqueSlug::generate(Post::class, 'Simple Post', 'slug');
// Output: simple-post
// Second time create post with title Simple Post
UniqueSlug::generate(Post::class, 'Simple Post', 'slug');
// Output: simple-post-1
// Third time create post with title Simple Post
UniqueSlug::generate(Post::class, 'Simple Post', 'slug');
// Output: simple-post-2
```
### Example #02 - Pass custom separator
Let's assume separator is `''` empty.
```php
// First time create user.
UniqueSlug::generate(User::class, 'arif', 'username', ''); // arif
// Second time create user.
UniqueSlug::generate(User::class, 'arif', 'username', ''); // arif1
// Third time create user.
UniqueSlug::generate(User::class, 'arif', 'username', ''); // arif2
```
### Example - Unique slug for category or any model easily
```php
public function create(array $data): Category|null
{
if (empty($data['slug'])) {
$data['slug'] = UniqueSlug::generate(Category::class, $data['name'], 'slug');
}
return Category::create($data);
}
```
## API Docs
### Generate method -
```php
UniqueSlug::generate($model, $value, $field, $separator);
```
```php
/**
* Generate a Unique Slug.
*
* @param object $model
* @param string $value
* @param string $field
* @param string $separator
*
* @return string
* @throws \Exception
*/
public function generate(
$model,
$value,
$field,
$separator = null
): string
```
#### Publish configuration
```sh
php artisan vendor:publish devboyarif/laravel-unique-slug
```
#### Configurations
```php
return [
/*
|--------------------------------------------------------------------------
| Default slug seperator
|--------------------------------------------------------------------------
|
| This is seperator for the slug value. IF no seperator is provided then this default seperator will be used as slug
|
*/
'seperator' => '-',
/*
|--------------------------------------------------------------------------
| Slug max count limit
|--------------------------------------------------------------------------
|
| Default 100, slug will generated like test-1, test-2, test-3 ... test-100
|
*/
'max_count' => 100,
];
```
## Contribution
You're open to create any Pull request.