You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](https://packagist.org/packages/:vendor_slug/:package_slug)
This repo can be used to scaffold a Laravel package. Follow these steps to get started:
6
+
[](https://packagist.org/packages/guava/sqids-for-laravel)
This package also comes with a trait that you can use in your Eloquent models. This trait will automatically add a sqid attribute which will be created from the model's primary key.
63
+
```php
64
+
use \Illuminate\Database\Eloquent\Model;
65
+
use \Guava\Sqids\Concerns\HasSqids;
66
+
67
+
class YourModel extends Model {
68
+
use HasSqids;
69
+
70
+
// ...
71
+
}
72
+
````
73
+
That's it! Now you can access the `sqid` attribute on your model.
74
+
75
+
You can custimize how the sqid on your model is generated by overriding the `getSqids` method:
76
+
```php
77
+
use \Illuminate\Database\Eloquent\Model;
78
+
use \Guava\Sqids\Concerns\HasSqids;
79
+
use \Guava\Sqids\Sqids;
80
+
81
+
class YourModel extends Model {
82
+
use HasSqids;
83
+
84
+
// ...
85
+
86
+
protected function getSqids(): Sqids
87
+
{
88
+
return Sqids::make()
89
+
->salt() // This will use the model's class name as the salt, so every model generates different IDs
90
+
// ... add more options here
91
+
);
92
+
}
93
+
}
94
+
```
95
+
96
+
### Route binding
97
+
If you want to be able to use the `sqid` as the route key, simply add the `HasSqidsRouting` trait to your model:
98
+
```php
99
+
use \Illuminate\Database\Eloquent\Model;
100
+
use \Guava\Sqids\Concerns\HasSqids;
101
+
use \Guava\Sqids\Concerns\HasSqidsRouting;
102
+
103
+
class YourModel extends Model {
104
+
use HasSqids, HasSqidsRouting;
105
+
106
+
// ...
107
+
}
50
108
```
51
109
52
-
This is the contents of the published config file:
0 commit comments