vinkla / hashids
A Hashids bridge for Laravel
Installs: 9 235 746
Dependents: 76
Suggesters: 3
Security: 0
Stars: 1 989
Watchers: 36
Forks: 173
Open Issues: 0
Requires
- php: ^8.2
- graham-campbell/manager: ^5.0
- hashids/hashids: ^5.0
- illuminate/contracts: ^11.0
- illuminate/support: ^11.0
Requires (Dev)
- graham-campbell/analyzer: ^4.1
- graham-campbell/testbench: ^6.1
- mockery/mockery: ^1.6.6
- phpunit/phpunit: ^10.0
README
Laravel Hashids
A Hashids bridge for Laravel.
// Encode integers. Hashids::encode(4815162342); // Decode strings. Hashids::decode('1LLb3b4ck'); // Dependency injection example. $hashidsManager->encode(911);
Installation
Require this package, with Composer, in the root directory of your project.
composer require vinkla/hashids
Configuration
Laravel Hashids requires connection configuration. To get started, you'll need to publish all vendor assets:
php artisan vendor:publish
This will create a config/hashids.php
file in your app that you can modify to set your configuration. Also, make sure you check for changes to the original config file in this package between releases.
Default Connection Name
This option default
is where you may specify which of the connections below you wish to use as your default connection for all work. Of course, you may use many connections at once using the manager class. The default value for this setting is main
.
Hashids Connections
This option connections
is where each of the connections are setup for your application. Example configuration has been included, but you may add as many connections as you would like.
Usage
Here you can see an example of you may use this package. Out of the box, the default adapter is main
. After you enter your authentication details in the config file, it will just work:
// You can alias this in config/app.php. use Vinkla\Hashids\Facades\Hashids; // We're done here - how easy was that, it just works! Hashids::encode(4815162342); // This example is simple and there are far more methods available. Hashids::decode('doyouthinkthatsairyourebreathingnow');
The manager will behave like it is a Hashids\Hashids
class. If you want to call specific connections, you can do that with the connection method:
use Vinkla\Hashids\Facades\Hashids; // Writing this... Hashids::connection('main')->encode($id); // ...is identical to writing this Hashids::encode($id); // and is also identical to writing this. Hashids::connection()->encode($id); // This is because the main connection is configured to be the default. Hashids::getDefaultConnection(); // This will return main. // We can change the default connection. Hashids::setDefaultConnection('alternative'); // The default is now alternative.
If you prefer to use dependency injection over facades, then you can inject the manager:
use Vinkla\Hashids\HashidsManager; class Foo { protected $hashids; public function __construct(HashidsManager $hashids) { $this->hashids = $hashids; } public function bar($id) { $this->hashids->encode($id); } } App::make('Foo')->bar();
For more information on how to use the Hashids\Hashids
class, check out the docs at hashids/hashids
.