Hashids is a small open-source library that generates short, unique, non-sequential ids from numbers.
It converts numbers like 347 into strings like “yr8”, or array of numbers like [27, 986] into “3kTMd”.
You can also decode those ids back. This is useful in bundling several parameters into one or simply using them as short UIDs.
Please check the documentation for usage examples.
- PHP 7.1 or higher
- October CMS build 420 or higher
php artisan plugin:install Vdlp.Hashids
Go to Settings > Updates & Plugins > Install plugins and search for 'Hashids'.
To configure this plugin execute the following command:
php artisan vendor:publish --provider="Vdlp\Hashids\ServiceProviders\HashidsServiceProvider" --tag="config"
This will create a
config/hashids.php file in your app where you can modify the configuration.
Here you can see an example of how to use this plugin. Out of the box, the default configuration used is
// You can use this class with Dependency Injection use Vdlp\Hashids\Classes\HashidsManager; /** @var HashidsManager $hashids */ $hashidsManager = resolve(HashidsManager::class); // Encodes the integer 1 to a hashid using the default configuration $hashidsManager->encode(1); $hashidsManager->instance()->encode(1); // Encodes the integer 1 to a hashid using a different configuration $hashidsManager->instance('different-configuration')->encode(1);
Questions? Need help?
If you have any question about how to use this plugin, please don't hesitate to contact us at firstname.lastname@example.org. We're happy to help you. You can also visit the support forum and drop your questions/issues there.
This plugin has not been reviewed yet.
Add PHP >= 7.1 as dependency
Jan 18, 2019
First version of Vdlp.Hashids
Jan 18, 2019