Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oneduo/laravel-human-keys
Use Stripe-like keys for your models, configurable and extendable
https://github.com/oneduo/laravel-human-keys
eloquent keys ksuid laravel models snowflake stripe
Last synced: about 1 month ago
JSON representation
Use Stripe-like keys for your models, configurable and extendable
- Host: GitHub
- URL: https://github.com/oneduo/laravel-human-keys
- Owner: oneduo
- License: mit
- Created: 2023-01-05T21:05:42.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-29T10:25:57.000Z (8 months ago)
- Last Synced: 2024-05-01T09:50:04.011Z (8 months ago)
- Topics: eloquent, keys, ksuid, laravel, models, snowflake, stripe
- Language: PHP
- Homepage:
- Size: 43 KB
- Stars: 33
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel Human Keys
[](https://packagist.org/packages/oneduo/laravel-human-keys)
[](https://github.com/oneduo/laravel-human-keys/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/oneduo/laravel-human-keys/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/oneduo/laravel-human-keys)
A package to use human readable keys in your Laravel models. Inspired by Stripe's id generation procedures.
Enables you to have KSUID keys in your models, which are human readable and sortable.
Example:
- `pos_2JvL8Gv5mirjbIVAlSRFrC8EaWR` for `Models/Post.php`
- `usr_p6UEyCc8D8ecLijAI5zVwOTP3D0` for `Models/User.php`
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Changelog](#changelog)
- [Contributing](#contributing)
- [Credits](#credits)
- [License](#license)
## Installation
You can install the package via composer:
```bash
composer require oneduo/laravel-human-keys
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag="human-keys-config"
```
This is the contents of the published config file:
```php
return [
/*
|--------------------------------------------------------------------------
| Generator
|--------------------------------------------------------------------------
|
| Used to define the generator to use for generating model keys.
|
| Supported:
| - ksuid (abc_p6UEyCc8D8ecLijAI5zVwOTP3D0)
| - snowflake (abc_1537200202186752)
|
| Default: ksuid
|
| Note: You may define your own generator by implementing the contract
| Oneduo\LaravelHumanKeys\Contracts\Generator and passing
| the class name to the generator config option.
|
| See the example below:
| 'generator' => \App\Services\MyGenerator::class
*/
'generator' => 'ksuid',
];
```
## Usage
To get started, use the `HasHumanKey` trait in your model:
```php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Oneduo\LaravelHumanKeys\Concerns\HasHumanKey;
class Post extends Model
{
use HasHumanKey;
}
```
When using the `ksuid` generator, the generated key will something like this: `pos_2JvL8Gv5mirjbIVAlSRFrC8EaWR`
When using the `snowflake` generator, the generated key will something like this: `pos_451734027389370636`
### Overriding the key prefix
You may set your own key prefix for each model by implementing the following method:
```php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Oneduo\LaravelHumanKeys\Concerns\HasHumanKey;
class Post extends Model
{
use HasHumanKey;
public static function getKeyPrefix() : string {
// prefix without _ underscore as it gets added by the generator
return 'post_prefix'
}
}
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Charaf Rezrazi](https://github.com/rezrazi)
- [All Contributors](../../contributors)
- [godruoyi/php-snowflake](https://github.com/godruoyi/php-snowflake)
- [tuupola/ksuid](https:/:github.com/tuupola/ksuid)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.