README

This package uses the classes created by hashids.org

Generate hashes from numbers, like YouTube or Bitly. Use hashids when you do not want to expose your database ids to the user.

Installation

Begin by installing the package through Composer. Edit your project's composer.json file to require ludo237/hashids.

"require": {
  "danphyxius/hashids": "1.3"
}

Next use Composer to update your project from the the Terminal:

php composer.phar update

Once the package has been installed you'll need to add the service provider. Open your app/config/app.php configuration file, and add a new item to the providers array.

'DanPhyxius\Hashids\HashidsServiceProvider'

After doing this you also need to add an alias. In your app/config/app.php file, add this to the aliases array.

'Hashids' => 'DanPhyxius\Hashids\Hashids'

Now last but not least you need to publish to package configuration from your Terminal:

php artisan config:publish danphyxius/hashids

Usage

Once you've followed all the steps and completed the installation you can use Hashids.

Encrypting

You can simply encrypt on id:

Hashids::encrypt(1); // Creating hash... Ri7Bi

or multiple..

Hashids::encrypt(1, 21, 12, 12, 666); // Creating hash... MMtaUpSGhdA

Decrypting

It's the same thing but the other way around:

Hashids::decrypt('Ri7Bi');

// Returns
array (size=1)
  0 => int 1

or multiple..

Hashids::decrypt('MMtaUpSGhdA');

// Returns
array (size=5)
  0 => int 1
  1 => int 21
  2 => int 12
  3 => int 12
  4 => int 666

Injecting Hashids

Now it's also possible to have Hashids injected into your class. Lets look at this controller as an example..

class ExampleController extends BaseController
{
    protected $hashids;

    public function __construct(Hashids\Hashids $hashids)
    {
        $this->hashids = $hashids;
    }

    public function getIndex()
    {
        $hash = $this->hashids->encrypt(1);
        return View::make('example.index', compact('hash'));
    }
}

The original classname and namespace has been bound in the IoC container to return our instantiated Hashids class.

Using IoC

Create a Hashids instance with the IoC

App::make('Hashids\Hashids')->encrypt(1);

That's it!

For documentation about Hashids itself, go to: https://github.com/ivanakimov/hashids.php.

Hopefully you'll enjoy this package and thanks to Ivan Akimov (@ivanakimov) for making Hashids. All credits for the Hashids package go to him.

danphyxius / hashids

Maintainers

Details