pfrug/hash-id

Simple trait for Laravel to encode IDs in URLs, providing a secure and obfuscated way to expose model identifiers

v1.0.0 2025-02-19 16:27 UTC

Requires

• jenssegers/optimus: ^1.1

Requires (Dev)

• phpunit/phpunit: ^11.5
• squizlabs/php_codesniffer: ^3.11

MIT

• P.Frugone

README

A simple trait for Laravel to encode IDs in URLs, providing a secure and obfuscated way to expose model identifiers.

Installation

To install the package, run the following command:

composer require pfrug/hash-id

Configuration

To publish the configuration file, use:

php artisan vendor:publish --tag="hashid-config"

This will create the hashid.php configuration file in the config directory.

Usage

1. To use the HashId trait, simply include it in your model:

use Pfrug\HashId;

class Post extends Model
{
    use HashId;
}

1. Getting the encoded ID in the route

In your route model binding, you can now use the encoded ID:

Route::get('/post/{post}', function (Post $post) {
    return $post;
});

This will automatically encode the id of your model in URLs.

Regenerate Configuration Values

If you want to regenerate the encoding values for prime, inverse, and random, you can use the following command:

php artisan hashid:regenerate

This will update the hashid.php configuration file with new values.

Running Tests

To run the tests for the package, use the following command:

vendor/bin/phpunit --configuration "phpunit.xml" --filter=HashIdTest

License

MIT License