Download the PHP package laravel-pulse/sluggish without Composer
On this page you can find all versions of the php package laravel-pulse/sluggish. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download laravel-pulse/sluggish
More information about laravel-pulse/sluggish
Files in laravel-pulse/sluggish
Package sluggish
Short Description A complete solution for generating slug, uuid and unique number for any laravel projects.
License MIT
Homepage https://github.com/laravel-pulse/sluggish
Informations about the package sluggish
Sluggish
Sluggish is a laravel library package for generating unique slug, custom slug, unique id, uuid, sequential number with prefix.
Requirements
PHP version : 8.0 or higher Laravel version : 8, 9, 10, 11 (capable with those versions)
Installation
Use the package run the following command.
configuration
publish the sluggish configuration files
This command will Publish default configuration inside config/sluggish.php
Usages
The best thing is you can use Sluggish everywhere as per as your needs.
For example Controllers, Models, Traits, Commands, jobs, etc.
What or Which properties Sluggish want
Sluggish want 4 mandatory parameters in order to generate a unique slug or UUID or Sequence number
1. string $type
- This parameter should contain what do you want to generate from Sluggish. It could be a string. Sluggish accept only three types one is "slug", "uuid" and "sequence".
2. string $parameter
- This parameter should contain what or which string or input should convert into a slug / uuid / sequence number. like "Hello world" or $request->title or your custom field.
3. object $model
- This parameter should contain the Model. Sluggish will execute the query and return the corresponding unique slug / uuid / sequence number. you can use any of your model like User::class, Post::class so on.
4. string $modelField
- This parameter should contain the corresponding Model field which you want to keep Unique. It could be any of your custom field. You can use any of your custom field like "slug", "username", "unique_id", or "unique_key".
If you want to update any of your custom fields records just pass the id. Sluggish will also accept the id field.
you need to pass in this order otherwise Sluggish can through an error
Generate Slug
Generate UUID
Generate Numeric series with prefix
Error
without any parameter you can get an exception
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.