Laravel Hashids is a package that provides a simple way to encode and decode unique identifiers into short, human-readable hashes. It’s particularly useful for obscuring numeric IDs, making them less predictable and improving the overall security of your application.
Key Features
- Obfuscation: Convert numeric IDs into short, unique hashes to enhance security.
- Customizable: Allows customization of hash length and alphabet.
- Simple Integration: Easy to set up and use within your Laravel application.
Installation
To install the package, you can use Composer. Run the following command in your terminal:
bash
1 |
composer require vinkla/hashids |
Configuration
After installing the package, you need to publish the configuration file:
bash
1 |
php artisan vendor:publish --provider="Vinkla\Hashids\HashidsServiceProvider" |
This will create a hashids.php
configuration file in the config
directory.
Configuration Options
Open the config/hashids.php
file to configure the package. You can set options like the salt, length, and alphabet for the hashes:
php
1 2 3 4 5 6 7 |
return [ 'default' => [ 'salt' => env('HASHIDS_SALT', 'your-salt-here'), 'length' => 8, // The length of the generated hashes 'alphabet' => 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890', // Custom alphabet ], ]; |
Usage
1. Encoding IDs
To encode an ID, you can use the Hashids
facade. Here’s an example:
php
1 2 3 4 5 |
use Hashids\Hashids; $hashids = new Hashids('your-salt-here'); $encoded = $hashids->encode(123); // Encode the ID 123 echo $encoded; // Example output: '5e8c9e' |
2. Decoding Hashes
To decode a hash back into the original ID:
php
1 2 |
$decoded = $hashids->decode($encoded); echo $decoded[0]; // Output: 123 |
Note: The decode
method returns an array of IDs. If the hash does not match any ID, it will return an empty array.
3. Using Hashids in Models
You can easily integrate Hashids into your models. For instance, if you want to automatically encode and decode the id
attribute in a User model, you can do the following:
- Add the Hashids Trait:Install the trait by adding it to your model:
php
1234567891011121314151617use Vinkla\Hashids\Facades\Hashids;class User extends Model{// Other model methods and propertiespublic function getRouteKey(){return Hashids::encode($this->id);}public static function findByHash($hash){$decoded = Hashids::decode($hash);return static::find($decoded[0] ?? null);}} - Using the Model with Routes:You can define routes that use the encoded IDs:
php
1234Route::get('user/{hash}', function ($hash) {$user = User::findByHash($hash);// Handle user...});
Conclusion
Laravel Hashids provides a straightforward way to generate short, unique hashes for your IDs, helping to obscure sensitive information and improve the user experience. Its simple setup and ease of use make it a valuable addition to any Laravel application.
- Laravel Breeze – Simple authentication starter kit
- Laravel Jetstream – Scaffolding for Laravel apps
- Laravel Passport – API authentication via OAuth2
- Laravel Sanctum – Simple API authentication
- Spatie Laravel Permission – Role and permission management
- Laravel Cashier – Subscription billing with Stripe
- Laravel Scout – Full-text search using Algolia
- Laravel Socialite – OAuth authentication (Google, Facebook, etc.)
- Laravel Excel – Excel import and export for Laravel
- Laravel Horizon – Redis queues monitoring
- Laravel Nova – Admin panel for Laravel
- Laravel Fortify – Backend authentication for Laravel
- Laravel Vapor – Serverless deployment on AWS
- Laravel Telescope – Debugging assistant for Laravel
- Laravel Dusk – Browser testing
- Laravel Mix – API for compiling assets
- Spatie Laravel Backup – Backup management
- Laravel Livewire – Building dynamic UIs
- Spatie Laravel Media Library – Manage media uploads
- Laravel Excel – Excel spreadsheet handling
- Laravel Debugbar – Debug tool for Laravel
- Laravel WebSockets – Real-time communication
- Spatie Laravel Sitemap – Generate sitemaps
- Laravel Spark – SaaS scaffolding
- Laravel Envoy – Task runner for deployment
- Spatie Laravel Translatable – Multilingual model support
- Laravel Backpack – Admin panel
- Laravel AdminLTE – Admin interface template
- Laravel Collective Forms & HTML – Simplified form and HTML generation
- Spatie Laravel Analytics – Google Analytics integration
- Laravel Eloquent Sluggable – Automatically create slugs
- Laravel Charts – Chart integration
- Laravel Auditing – Track changes in models
- Laravel JWT Auth – JSON Web Token authentication
- Laravel Queue Monitor – Monitor job queues
- Spatie Laravel Query Builder – Filter, sort, and include relationships in Eloquent queries
- Laravel Datatables – jQuery Datatables API
- Laravel Localization – Multilingual support for views and routes
- Laravel Acl Manager – Access control list manager
- Laravel Activity Log – Record activity in your app
- Laravel Roles – Role-based access control
- Spatie Laravel Tags – Tagging models
- Laravel Installer – CLI installer for Laravel
- Laravel Breadcrumbs – Generate breadcrumbs in Laravel
- Laravel Mailgun – Mailgun integration for Laravel
- Laravel Trustup Model History – Store model change history
- Laravel Deployer – Deployment automation tool
- Laravel Auth – Custom authentication guards
- Laravel CORS – Cross-Origin Resource Sharing (CORS) support
- Laravel Notifications – Send notifications through multiple channels
- Spatie Laravel Http Logger – Log HTTP requests
- Laravel Permission Manager – Manage permissions easily
- Laravel Stubs – Customize default stubs in Laravel
- Laravel Fast Excel – Speed up Excel exports
- Laravel Image – Image processing
- Spatie Laravel Backup Server – Centralize backups for Laravel apps
- Laravel Forge API – Manage servers through the Forge API
- Laravel Blade SVG – Use SVGs in Blade templates
- Laravel Ban – Ban/unban users from your application
- Laravel API Response – Standardize API responses
- Laravel SEO – Manage SEO meta tags
- Laravel Settings – Store and retrieve settings
- Laravel DOMPDF – Generate PDFs
- Laravel Turbo – Full-stack framework for building modern web apps
- Spatie Laravel Event Sourcing – Event sourcing implementation
- Laravel Jetstream Inertia – Jetstream’s Inertia.js integration
- Laravel Envoy Tasks – Task automation
- Laravel Likeable – Like/dislike functionality
- Laravel GeoIP – Determine visitor’s geographic location
- Laravel Country State City – Dropdowns for country, state, and city
- Laravel Hashids – Generate short unique hashes
- Laravel Repository – Repository pattern for Laravel
- Laravel UUID – UUID generation for models
- Spatie Laravel Medialibrary Pro – Enhanced media management
- Laravel Queue Monitor – Monitor Laravel job queues
- Laravel User Activity – Monitor user activity
- Laravel DB Snapshots – Create database snapshots
- Laravel Twilio – Twilio integration
- Laravel Roles – Role-based permission handling
- Laravel Translatable – Add translations to Eloquent models
- Laravel Teamwork – Manage teams in multi-tenant apps
- Laravel Full Text Search – Add full-text search to Laravel models
- Laravel File Manager – File and media management
- Laravel User Timezones – Automatically detect user time zones
- Laravel ChartsJS – Render charts with ChartsJS
- Laravel Stripe – Stripe API integration
- Laravel PDF Generator – PDF generation
- Laravel Elasticsearch – Elasticsearch integration
- Laravel Simple Qrcode – Generate QR codes
- Laravel Timezone – Manage timezones and conversions
- Laravel Collective API – API management for Laravel
- Laravel Rest API Boilerplate – REST API starter kit
- Laravel Multi Auth – Multi-authentication functionality
- Laravel Voyager – Admin panel for Laravel
- Laravel Voyager Database – Database manager for Voyager
- Laravel Categories – Handle categories for models
- Laravel Multitenancy – Multi-tenancy implementation
- Laravel Access Control – Advanced access control for users
- Laravel Menus – Menu management
- Laravel Translatable Routes – Multilingual route handling