Download the PHP package jenssegers/optimus without Composer
On this page you can find all versions of the php package jenssegers/optimus. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jenssegers/optimus
More information about jenssegers/optimus
Files in jenssegers/optimus
Package optimus
Short Description Id obfuscation based on Knuth's integer hash method
License MIT
Homepage https://github.com/jenssegers/optimus
Informations about the package optimus
Optimus id transformation
With this library, you can transform your internal id's to obfuscated integers based on Knuth's integer hash. It is similar to Hashids, but will generate integers instead of random strings. It is also super fast.
Installation
Install using composer:
If you will be running your code on a 32 bit system or will be working with large prime numbers it is suggested that you install the GMP extension. For debian/ubuntu you can install the extension with one of these commands:
Usage
To get started you will need 3 things;
- Large prime number lower than
2147483647
- The inverse prime so that
(PRIME * INVERSE) & MAXID == 1
- A large random integer lower than
2147483647
Luckily for you, I have included a console command that can do all of this for you. To get started, just run the following command:
If you prefer to choose your own prime number (from this list for example), you can pass it to the command to calculate the remaining numbers:
Using those numbers, you can start creating instances of Optimus($prime, $inverted, $random)
:
NOTE: Make sure that you are using the same constructor values throughout your entire application!
Encoding and decoding
To encode id's, use the encode
method:
To decode the resulting 1535832388
back to its original value, use the decode
method:
Framework Integrations
Laravel
This is an example service provider which registers a shared Optimus instance for your entire application:
Once you have created the service provider, add it to the providers array in your config/app.php
configuration file:
Laravel's automatic injection will pass this instance where needed. Example controller:
More information: https://laravel.com/docs/5.3/container#resolving
Third-party integrations
- An integration with Laravel is provided by the propaganistas/laravel-fakeid package.
- Laravel Optimus with multiple connections provided by the cybercog/laravel-optimus package.
- An integration with Silex 2 is provided by the jaam/silex-optimus-provider package.
- An integration with Laravel is provided by the elfsundae/laravel-hashid package.
- A PSR-15 middleware provided by the icanhazstring/optimus-middleware package.
Security contact information
To report a security vulnerability, follow these steps.
License
The MIT License.
All versions of optimus with dependencies
phpseclib/phpseclib Version ^3.0
symfony/console Version ^5.0||^6.0||^7.0