ggmm-one / eloquent-hashids

v1.3.0 2020-12-25 10:00 UTC

Requires

• hashids/hashids: ^4
• illuminate/database: 6.*|7.*|8.*

MIT

• ggmm-one

Published on Packagist.org on 2020-12-25 10:02 UTC

README

Do you want to hide your primary keys in your Laravel app urls?

Add hashids to your Eloquent models on-the-fly. No need for extra database columns.

How to use

Install it using composer

composer require ggmm-one/eloquent-hashids

Use the HasHashid trait on your models

use Ggmm\Model\HasHashid;

class Car extends Model
{
    use HasHashid;
}

# now your model has a hashid attribute

$car->hashid;

# to find the id from a hashid use decodeHashid

$car->decodeHashid('hashidhere');

Note: your model's primary key must be a positive integer

Routing

To use the hashid on your model's routing use the trait HashidRoutable.

use Ggmm\Model\HasHashid;
use Ggmm\Model\HashidRoutable

class Car extends Model
{
    use HasHashid;
    use HashidRoutable
}

# Now instead of a url like https://example.org/car/11/edit
# You will have a url like https://example.org/car/xLq/edit

Query builder

HasHashid provide the useful QueryBuilder-similar methods: findByHashid, findManyByHashid, findOrFailByHashid, findOrNewByHashid.

Advanced

If you want to customise the hashid generation, set the hashidGenerator on the constructor. For options, see vinkla/hashids.

use Hashids\Hashids;

class Car extends Model
{
    use HasHashid;

    public function __constructor()
    {
        $this->hashidGenerator = new Hashids('myhashsaltgoeshere');
    }
}

Note: the hashing on this library has no cryptographic value. Do not use to implement any security scheme.