Download the PHP package eriksulymosi/eloquent-sqids without Composer
On this page you can find all versions of the php package eriksulymosi/eloquent-sqids. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download eriksulymosi/eloquent-sqids
More information about eriksulymosi/eloquent-sqids
Files in eriksulymosi/eloquent-sqids
Package eloquent-sqids
Short Description On-the-fly sqids for Laravel Eloquent models.
License MIT
Informations about the package eloquent-sqids
Using sqids instead of integer ids in urls and list items can be more appealing and clever. For more information visit sqids.org.
This package is based on mtvs's eloquent-hashids package.
Eloquent-Sqids 
This adds sqids to Laravel Eloquent models by encoding/decoding them on the fly rather than persisting them in the database. So no need for another database column and also higher performance by using primary keys in queries.
Features include:
- Generating sqids for models
- Resloving sqids to models
- Ability to customize sqid settings for each model
- Route binding with sqids (optional)
Installation
Install the package with Composer:
Also, publish the vendor config files to your application (necessary for the dependencies):
Setup
Base features are provided by using HasSqid
trait then route binding with
sqids can be added by using SqidRouting
.
Usage
Basics
Add the sqid to the serialized model
Set it as default:
or specify it specificly:
return $item->append('sqid')->toJson();
Implicit Route Bindings
If you want to resolve implicit route bindings for the model using its hahsid
value you can use SqidRouting
in the model.
It overwrites getRouteKeyName()
, getRouteKey()
and resolveRouteBindingQuery()
to use the sqids as the route keys.
It supports the Laravel's feature for customizing the key for specific routes.
Customizing The Default Route Key Name
If you want to by default resolve the implicit route bindings using another
field you can overwrite getRouteKeyName()
to return the field's name to the
resolving process and getRouteKey()
to return its value in your links.
You'll still be able to specify the sqid for specific routes.
Supporting The Other Laravel's Implicit Route Binding Features
When using SqidRouting
you'll still be able to use softdeletable and child
route bindings.