nblackburn / laravel-hashids
A hashids wrapper for Laravel and Lumen.
Installs: 14 190
Dependents: 0
Suggesters: 0
Security: 0
Stars: 9
Watchers: 1
Forks: 5
Open Issues: 4
Requires
- hashids/hashids: ^1.0.0
- illuminate/support: ^5.2.0
Requires (Dev)
- phpunit/phpunit: ^5.0.0
This package is not auto-updated.
Last update: 2023-10-14 05:24:59 UTC
README
A hashids wrapper for Laravel & Lumen.
Installation
Laravel
Inside config/app.php
add the following line in your providers
LaravelHashids\Providers\LaravelServiceProvider::class
and then simply run the following artisan command...
php artisan config:publish nblackburn/laravel-hashids
Facade
To add facade support for Laravel, add the following line inside your config/app.php
under the alias section...
'Parsedown' => LaravelParsedown\Facades\Parsedown::class,
Lumen
Inside bootstrap/app.php
, add the following line:
$app->register(LaravelHashids\Providers\LumenServiceProvider::class);
then add the following to your .env
file:
# HASHIDS HASHIDS_SALT = YOURSECRETKEY HASHIDS_LENGTH = 8 HASHIDS_ALPHABET = abcedfghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPAQRSTUVWXYZ1234567890
Facade
To add facade support, firstly uncomment the following line within bootstrap/app.php
:
// $app->withFacades();
then register the facade like so...
$app->register(LaravelHashids\Facades\Hashids::class);
Settings
name | description | default |
---|---|---|
salt | The secret used for hashing. | MYREALLYSECRETSALT |
length | The maximum length of the hash. | 10 |
alphabet | The characters used for hashing. | abcedefghijklmnopqrstuvwxyzABCEDEFGHIJKLMNOPQRSTUVWXYZ123456890 |
Usage
Encode
Encode a series of integers
app('hashids')->encode(...$integers);
or with the facade
Hashids::encode(...$integers);
Decode
Decode a encoded string back to the original integers
app('hashids')->decode($encoded);
or with the facade
Hashids::decode($encoded);
License
This library is licensed under MIT, see license.md for details.