Download the PHP package padosoft/laravel-sluggable without Composer
On this page you can find all versions of the php package padosoft/laravel-sluggable. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download padosoft/laravel-sluggable
More information about padosoft/laravel-sluggable
Files in padosoft/laravel-sluggable
Package laravel-sluggable
Short Description Generate slugs when saving Eloquent models
License MIT
Homepage https://github.com/padosoft/laravel-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 laravel-sluggable
Generate slugs when saving Eloquent models
This package provides a trait that will generate a unique slug when saving any Eloquent model.
NOTE: This package is based on spatie/laravel-sluggable but with some adjustments for me and few improvements. Here's a major changes:
- Added the ability to specify a source field through a model relation with dot notation. Ex.: ['category.name'] or ['customer.country.code'] where category, customer and country are model relations.
-
Added the ability to specify multiple fields with priority to look up the first non-empty source field. Ex.: In the example above, we set the look up to find a non empty source in model for slug in this order: title, first_name and last_name. Note: slug is set if at least one of these fields is not empty:
- Added option to set the behaviour when the source fields are all empty (thrown an exception or generate a random slug).
- Remove the abstract function getSlugOptions() and introduce the ability to set the trait with zero configuration with default options. The ability to define getSlugOptions() function in your model remained.
- Added option to set slug separator
- Some other adjustments and fix
Overview
The slugs are generated with Laravels str_slug method, whereby spaces are converted to '-'.
Requires
- php: >=7.0.0
- illuminate/database: ^5.0
- illuminate/support: ^5.0
Installation
You can install the package via composer:
Usage
Your Eloquent models should use the Padosoft\Sluggable\HasSlug trait and the Padosoft\Sluggable\SlugOptions class.
The trait shipping with ZERO Configuration if your model contains the slug attribute and one of the fields specified in getSlugOptionsDefault().
If the zero config not for you, you can define getSlugOptions() method in your model.
Here's an example of how to implement the trait with zero configuration:
Here's an example of how to implement the trait with implementation of getSlugOptions():
Want to use multiple field as the basis for a slug? No problem!
Want to use relation field as the basis for a slug? No problem!
where category is a relation in your model:
If you want to use a specific language for the slug creation
If you want to use a specific convertion dictionary
It support chaining for relation so you can also pass a customer..
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.
By default the package will generate a random 50char slug if all source fields are empty.
You can disable this behaviour by calling disallowSlugIfAllSourceFieldsEmpty
and set the random string char lenght by calling randomSlugsShouldBeNoLongerThan.
You can also put a maximum size limit on the created slug and/or the lenght of random 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 override the generated slug just by setting it to another value then the generated slug.
Custom slug (i.e.: manually set slug url)
If you want a custom slug write by hand, use the saveCustomSlugsTo() method to set the custom field:
Then, if you set the url-custom attribute in your model, the slug field will be set to same value.
In any case, check for correct url and uniquity will be performed to custom slug value.
Example:
SluggableScope Helpers
The package included some helper functions for working with models and their slugs. You can do things such as:
Change log
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 instead of using the issue tracker.
Credits
- Lorenzo Padovani
- Freek Van der Herten
- All Contributors
About Padosoft
Padosoft (https://www.padosoft.com) is a software house based in Florence, Italy. Specialized in E-commerce and web sites.
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-sluggable with dependencies
illuminate/database Version ^5.7|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0
illuminate/support Version ^5.7|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0