mvaliolahi/smart-hash

Laravel Smart Hash Model id and request.

v0.0.17 2024-02-28 12:16 UTC

Requires

• hashids/hashids: ^4.1

Requires (Dev)

• laravel/framework: ^8.0
• orchestra/testbench: ^6.0
• phpunit/phpunit: ^9.0

MIT

• Meysam Valiolahi

README

What is the hashids?

Hashids is a small open-source library that generates short, unique, non-sequential ids from numbers. It converts numbers like 347 into strings like “yr8”, or array of numbers like [27, 986] into “3kTMd”.

For more information visit hashids.org.

Why we should use this library?

Your client deals with hash id, but each time your app received id or ids in the request SmartHash will decode it for you.

• Easy to use!
• Hidden your database ids from client.
• Automatic encode model id for front-end and decode for back-end (Decode all id or ids requests from parameters or the body)
• Does not need to methods like findByHashid

Installation

$ composer require mvaliolahi/smart-hash

$ php artisan vendor:publish

How to use

1. inside your Model use SmartHash trait.

class Category extends Model
{
    use SmartHash;
}

$category->hashId()

After use SmartHash Trait, Category::first()->id will return jR not 1, You can access to original id using the $category->id() method.

1. Inside you boot method in AppServiceProvider define your models because of route model binding:

$this->app->singleton('smart-hash', function() {
    return [
        'category' => Category::class,
        'user'     => User::class,
    ];
});

Add a new parameter to decoder lookup-table

edit config/smart-hash.php file, next step is obvious! for example, if we want to auto decode parameters like id, category_id and array parameter like ids, config is like below.

<?php

return [
    'single_parameters' => [
        'id', 
        'category_id'
    ],
    'array_parameters' => [
        'ids',
    ]
];

Manual find

$post = Post::findByHash('vm');
$post = Post::findOrFailByHash('vm');