jimchen/yii2-hashids

Hashids for Yii framework

0.1.0 2018-08-29 08:01 UTC

This package is auto-updated.

Last update: 2022-05-05 14:01:27 UTC


README

Hashids for Yii framework

Installing

$ composer require jimchen/yii2-hashids -vvv

Usage

Configure application components as follows

return [
    //...
    'components' => [
        //...
        'hashids' => [
            'class' => 'jimchen\hashids\HashidsComponent',
            'salt' => 'default channel salt',
            'length' => 'default channel length of the encode string',
            // 'default' => 'main' // default channel
            // 'connections' => null // other channel
        ],
    ],
];

the connections should defined like:

[
    ...
    'connections' => [
        'channel name' => [
            'salt' => 'the salt',
            'length' => 'the length of the encode string',
        ],
        ...
    ]
]

Use in your code as follows(it use the default channel.)

use Yii;

$encode = Yii::$app->hashids->encode(12345);

var_dump(Yii::$app->hashids->decode($encode)); // [12345]

Use other channel

use Yii;

$otherChannelHashids = \Yii::createObject('hashids.manager')->connection('channel name');

$encode = $otherChannelHashids->encode(12345);

var_dump($otherChannelHashids->decode($encode)); // [12345]

License

MIT