Download the PHP package bvtterfly/laravel-hashids without Composer
On this page you can find all versions of the php package bvtterfly/laravel-hashids. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download bvtterfly/laravel-hashids
More information about bvtterfly/laravel-hashids
Files in bvtterfly/laravel-hashids
Package laravel-hashids
Short Description A package to generate hashids for Eloquent models
License MIT
Homepage https://github.com/bvtterfly/laravel-hashids
Informations about the package laravel-hashids
🚨 THIS PACKAGE HAS BEEN ABANDONED 🚨
I no longer use Laravel and cannot justify the time needed to maintain this package. That's why I have chosen to abandon it. Feel free to fork my code and maintain your own copy.
Laravel Hashids
This package provides a trait that will generate hashids when saving any Eloquent model.
Hashids
Hashids is a small package to generate YouTube-like IDs from numbers. It converts numbers like 347
into strings like yr8
.
Installation
You can install the package via composer:
You can publish the config file with:
This is the contents of the published config file:
Usage
Your Eloquent models should have the Bvtterfly\LaravelHashids\HasHashId
trait that contains an abstract getHashIdOptions
method that you must implement yourself, and it should return the Bvtterfly\LaravelHashids\HashIdOptions
class.
Your models' migrations should have a field to save the generated hashid to.
Here's an example of what a model would look like:
By default, Package will generate hashids from models'
id
.
And Its migration:
The
hashid
column is generated from theid
field, Butid
is an auto-increment column and doesn't have value before saving in the DB. So, Thehashid
column must be nullable. And The Package will generatehashid
and update the model after being saved in the database.
Generate from Hex numbers
If you want to generate hashids from hex numbers like Mongo's ObjectIds, you can change the type to the hex
:
Generate from another field
Generate from field with value
By default, This package will generate hashids and update the model from the auto-incremented id
column after being saved in the database. Still, if your field has value, you can change it to generate hashids while saving:
Use the same hashids among models
The package will add the models' table to the default salt to generate a unique output id per model. If you want your Post
and User
models to share the same output id when id = 1
:
Use padding to make your output ids longer
Without padding, encoding of 1
returns something like jR
, but You can use padding to have a longer output id.
Note that output ids are only padded to fit at least a certain length. It doesn't mean that they will be exactly that length.
Using a custom alphabet
Using Hashids in routes
To use the hashids in routes, you may specify the hashid column in the route parameter definition:
or If you would like model binding to always use the hashid column other than id when retrieving a given model class, you may override the getRouteKeyName method on the Eloquent model:
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- ARI
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-hashids with dependencies
hashids/hashids Version ^4.1
illuminate/contracts Version ^9.0|^10.0
spatie/laravel-package-tools Version ^1.9.2