Download the PHP package marshmallow/sluggable without Composer
On this page you can find all versions of the php package marshmallow/sluggable. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download marshmallow/sluggable
More information about marshmallow/sluggable
Files in marshmallow/sluggable
Package sluggable
Short Description Generate slugs when saving Eloquent models
License MIT
Homepage https://gitlab.com/marshmallow-packages/sluggable
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package sluggable
Generate slugs when saving Eloquent models
This package was created by Spatie. We have forked it so we can add new features we need and so we are not dependend on Spatie before we can upgrade to new Laravel versions.
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 Marshmallow\Sluggable\HasSlug trait and the Marshmallow\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 the slug to be generated again on model updates, call generateSlugsOnUpdate().
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.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Freek Van der Herten
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of sluggable with dependencies
illuminate/database Version ^7.0|^8.0|^9.0|^10.0|^11.0
illuminate/support Version ^7.0|^8.0|^9.0|^10.0|^11.0