Download the PHP package oddvalue/laravel-sluggable without Composer
On this page you can find all versions of the php package oddvalue/laravel-sluggable. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package laravel-sluggable
Fork of https://github.com/spatie/laravel-sluggable to allow use on L8 with PHP 7.3, unless you need that use the original package
Generate slugs when saving Eloquent models
This package provides a trait that will generate a unique slug when saving any Eloquent model.
The slugs are generated with Laravels Str::slug
method, whereby spaces are converted to '-'.
Installation
You can install the package via composer:
Usage
Your Eloquent models should use the Oddvalue\Sluggable\HasSlug
trait and the Oddvalue\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:
With its migration:
To use the generated slug in routes, remember to use Laravel's implicit route model binding:
Want to use multiple field as the basis for a slug? No problem!
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
.
You can also put a maximum size limit on the created slug:
The slug may be slightly longer than the value specified, due to the suffix which is added to make it unique.
You can also use a custom separator by calling usingSeparator
To set the language used by Str::slug
you may call usingLanguage
You can also override the generated slug just by setting it to another value than the generated slug.
If you don't want to create the slug when the model is initially created you can set use the doNotGenerateSlugsOnCreate()
function.
Similarly, if you want to prevent the slug from being updated on model updates, call doNotGenerateSlugsOnUpdate()
.
This can be helpful for creating permalinks that don't change until you explicitly want it to.
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.
Changelog
Please see CHANGELOG for more information what has changed recently.
Testing
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Postcardware
You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Oddvalue, Samberstraat 69D, 2060 Antwerp, Belgium.
We publish all received postcards on our company website.
Credits
- Freek Van der Herten
- All Contributors
Support us
Oddvalue is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
Does your business depend on our contributions? Reach out and support us on Patreon. All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-sluggable with dependencies
illuminate/database Version ~5.6.0|~5.7.0|~5.8.0|^6.0|^7.0|^8.0
illuminate/support Version ~5.6.0|~5.7.0|~5.8.0|^6.0|^7.0|^8.0