README

Short, obfuscated and efficient IDs for PHP

No database changes are required. The original (integer) IDs are all you need.

No collisions. Reversible.

Why do I need this?

• Don't leak information to your competitors (e.g. number of orders, sign-ups per day)
• Prevent resource enumeration by waiving sequential IDs
• Mix up IDs a little bit in order to make guessing them harder
• Security through obscurity

Requirements

• PHP 5.6.0+
  • GMP extension

Installation

1. Include the library via Composer [?]:

   $ composer require delight-im/ids
   

2. Include the Composer autoloader:

   require __DIR__ . '/vendor/autoload.php';

Usage

Creating an instance

$generator = new \Delight\Ids\Id();

Encoding and decoding IDs

$generator->encode(6); // => "43Vht7"
$generator->decode('43Vht7'); // => 6

Shortening a number without obfuscating it

$generator->shorten(3141592); // => "vJST"
$generator->unshorten("vJST"); // => 3141592

Obfuscating a number without shortening it

$generator->obfuscate(42); // => 958870139
$generator->deobfuscate(958870139); // => 42

Customization

1. Shuffle the characters of the alphabet that is used for the base conversion. Calling \Delight\Ids\Id::createRandomAlphabet() may be helpful for that purpose. You might also change the alphabet entirely, but there's usually no need to do that.
2. Pass your new alphabet to the constructor as the first argument.
3. Clone this repository and then execute the file tests/index.php to generate your custom prime number, inverse prime and random number for Knuth's multiplicative hashing.
4. Pass your three new numbers to the constructor as the second, third and fourth argument, respectively.

Contributing

All contributions are welcome! If you wish to contribute, please create an issue first so that your feature, problem or question can be discussed.

License

This project is licensed under the terms of the MIT License.