Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mtvs/eloquent-hashids
On-the-fly hashids for Laravel Eloquent models. (🍰 Easy & ⚡ Fast)
https://github.com/mtvs/eloquent-hashids
eloquent eloquent-models hashids laravel php
Last synced: 2 months ago
JSON representation
On-the-fly hashids for Laravel Eloquent models. (🍰 Easy & ⚡ Fast)
- Host: GitHub
- URL: https://github.com/mtvs/eloquent-hashids
- Owner: mtvs
- Created: 2019-07-20T08:04:33.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-05-07T16:22:09.000Z (9 months ago)
- Last Synced: 2024-10-20T18:12:40.622Z (3 months ago)
- Topics: eloquent, eloquent-models, hashids, laravel, php
- Language: PHP
- Homepage:
- Size: 42 KB
- Stars: 291
- Watchers: 7
- Forks: 21
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
> Using hashids instead of integer ids in urls and list items can be more
appealing and clever. For more information visit [hashids.org](https://hashids.org/).
# Eloquent-Hashids 
This adds hashids to Laravel Eloquent models by encoding/decoding them on the fly
rather than persisting them in the database. So no need for another database column
and also higher performance by using primary keys in queries.
Features include:
* Generating hashids for models
* Resloving hashids to models
* Ability to customize hashid settings for each model
* Route binding with hashids (optional)
## Installation
Install the package with Composer:
```sh
$ composer require mtvs/eloquent-hashids
```
Also, publish the vendor config files to your application (necessary for the dependencies):
```sh
$ php artisan vendor:publish
```
## Setup
Base features are provided by using `HasHashid` trait then route binding with
hashids can be added by using `HashidRouting`.
```php
use Illuminate\Database\Eloquent\Model;
use Mtvs\EloquentHashids\HasHashid;
use Mtvs\EloquentHashids\HashidRouting;
Class Item extends Model
{
use HasHashid, HashidRouting;
}
```
### Custom Hashid Settings
It's possible to customize hashids settings for each model by overwriting
`getHashidsConnection()`. It must return the name of a connection of
[`vinkla/hashids`](https://github.com/vinkla/laravel-hashids) that provides
the desired settings.
## Usage
### Basics
```php
// Generating the model hashid based on its key
$item->hashid();
// Equivalent to the above but with the attribute style
$item->hashid;
// Finding a model based on the provided hashid or
// returning null on failure
Item::findByHashid($hashid);
// Finding a model based on the provided hashid or
// throwing a ModelNotFoundException on failure
Item::findByHashidOrFail($hashid);
// Decoding a hashid to its equivalent id
$item->hashidToId($hashid);
// Encoding an id to its equivalent hashid
$item->idToHashid($id);
// Getting the name of the hashid connection
$item->getHashidsConnection();
```
### Add the hashid to the serialized model
Set it as default:
```php
use Illuminate\Database\Eloquent\Model;
use Mtvs\EloquentHashids\HasHashid;
class Item extends Model
{
use HasHashid;
/**
* The accessors to append to the model's array form.
*
* @var array
*/
protected $appends = ['hashid'];
}
```
or specify it specificly:
`return $item->append('hashid')->toJson();`
### Implicit Route Bindings
If you want to resolve implicit route bindings for the model using its hahsid
value you can use `HashidRouting` in the model.
```php
use Illuminate\Database\Eloquent\Model;
use Mtvs\EloquentHashids\HasHashid;
use Mtvs\EloquentHashids\HashidRouting;
class Item extends Model
{
use HasHashid, HashidRouting;
}
```
It overwrites `getRouteKeyName()`, `getRouteKey()` and `resolveRouteBindingQuery()`
to use the hashids as the route keys.
It supports the Laravel's feature for customizing the key for specific routes.
```php
Route::get('/items/{item:slug}', function (Item $item) {
return $item;
});
```
#### Customizing The Default Route Key Name
If you want to by default resolve the implicit route bindings using another
field you can overwrite `getRouteKeyName()` to return the field's name to the
resolving process and `getRouteKey()` to return its value in your links.
```php
use Illuminate\Database\Eloquent\Model;
use Mtvs\EloquentHashids\HasHashid;
use Mtvs\EloquentHashids\HashidRouting;
class Item extends Model
{
use HasHashid, HashidRouting;
public function getRouteKeyName()
{
return 'slug';
}
public function getRouteKey()
{
return $this->slug;
}
}
```
You'll still be able to specify the hashid for specific routes.
```php
Route::get('/items/{item:hashid}', function (Item $item) {
return $item;
});
```
#### Supporting The Other Laravel's Implicit Route Binding Features
When using `HashidRouting` you'll still be able to use softdeletable and child
route bindings.
```php
Route::get('/items/{item}', function (Item $item) {
return $item;
})->withTrashed();
Route::get('/user/{user}/items/{item}', function (User $user, Item $item) {
return $item;
})->scopeBindings();
```