Wallogit.com
2017 © Pedro PelĂĄez
Generate hashes like YouTube or Bitly from numbers to obfuscate your database IDs, or navigate to the right shard.
, (*1)
======, (*2)
A small PHP class to generate YouTube-like hashes from numbers. Read documentation at http://www.hashids.org/php/, (*3)
, (*4)
You can either require() the lib yourself, or use Composer (packagist has hashids/hashids package)., (*5)
In your composer.json file use:, (*6)
``` json { "require": { "hashids/hashids": "*" } }, (*7)
And run: `php composer.phar install`. After that you can require the autoloader and use Hashids: ``` php <?php require_once 'vendor/autoload.php' $hashids = new Hashids\Hashids('this is my salt');
<?php
$hashids = new Hashids\Hashids('this is my salt');
$hash = $hashids->encrypt(1, 2, 3);
$numbers = $hashids->decrypt($hash);
var_dump($hash, $numbers);
string(5) "laHquq"
array(3) {
[0]=>
int(1)
[1]=>
int(2)
[2]=>
int(3)
}
Each number passed to the constructor cannot be negative or greater than 1 billion (1,000,000,000). Hashids encrypt() function will return an empty string if at least one of the numbers is out of bounds. Be sure to check for that -- no exception is thrown., (*8)
PHP starts approximating numbers when it does arithmetic on large integers (by converting them to floats). Which is usually not a big issue, but a problem when precise integers are needed., (*9)
However, if you have either GNU Multiple Precision --with-gmp, or BCMath Arbitrary Precision Mathematics --enable-bcmath libraries installed, Hashids will increase its upper limit to PHP_INT_MAX which is int(2147483647) on 32-bit systems and int(9223372036854775807) on 64-bit., (*10)
It will then use regular arithmetic on numbers less than 1 billion (because it's faster), and one of these libraries if greater than. GMP takes precedence over BCMath., (*11)
You can get the upper limit by doing: $hashids->get_max_int_value(); (which will stay at 1 billion if neither of the libraries is installed)., (*12)
Even though speed is an important factor of every hashing algorithm, primary goal here was encoding several numbers at once while avoiding collisions., (*13)
On a 2.7 GHz Intel Core i7 with 16GB of RAM, it takes roughly:, (*14)
for loop.On a 2.26 GHz Intel Core 2 Duo with 8GB of RAM, it takes about:, (*15)
for loop.Sidenote: The numbers tested with were relatively small -- if you increase them, the speed will obviously decrease., (*16)
This code was written with the intent of placing created hashes in visible places - like the URL. Which makes it unfortunate if generated hashes accidentally formed a bad word., (*17)
Therefore, the algorithm tries to avoid generating most common English curse words. This is done by never placing the following letters next to each other:, (*18)
c, C, s, S, f, F, h, H, u, U, i, I, t, T
0.3.1, (*19)
0.3.0 - Warning: Hashes change in this version:, (*20)
PHP_INT_MAX is used.0.2.1, (*21)
Hashids added to library class0.2.0 - Warning: Hashes change in this version:, (*22)
hashids to Hashids
0.1.3 - Warning: Hashes change in this version:, (*23)
0.1.2 - Warning: Hashes change in this version:, (*24)
encode/decode to encrypt/decrypt
0.1.1, (*25)
0.1.0, (*26)
I am on the internets @IvanAkimov, (*27)
MIT License. See the LICENSE file. You can use Hashids in open source projects and commercial products. Don't break the Internet. Kthxbye., (*28)
Generate hashes like YouTube or Bitly from numbers to obfuscate your database IDs, or navigate to the right shard.
MIT
encrypt decrypt bitly hash youtube ids hashids obfuscate