README

This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what PSRs you support to avoid any confusion with users and contributors.

Installation

You can install the package via composer:

composer require assumilhig/laravel-key-generator

You can publish everything with:

php artisan vendor:publish --provider="Assumilhig\LaravelKeyGenerator\LaravelKeyGeneratorServiceProvider"

This is the contents of the published config file:

return [
    'length' => 20
];

Usage

There are two available methods to generate the key:

Using the Laravel Key Generator

LaravelKeyGenerator::generate(
    prefix: 'test', // what you want to prefix your keys with.
    length: 20, // optional - the default of 20 is set in the config.
)

Using the Str Key

Illuminate\Support\Str::Key(
    prefix: 'test', // what you want to prefix your keys with.
    length: 20, // optional - the default of 20 is set in the config.
)

Eloquent Integration

There is an eloquent model trait available to use called HasKey which will:

namespace App\Models;

use Assumilhig\LaravelKeyGenerator\HasKey;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;

class Category extends Model
{
    use HasKey;
    use HasFactory;

    public $timestamps = false;

    protected $fillable = [
      'key'
    ];
}

When you are creating an eloquent model, the trait will be booted. It will get the first 3 characters of the Model name, force them to lowercase and append a "_" and use this as the prefix for the Key Factory

An example:

Category Model: cat_N6mU3u0aTgktLQnAsxwU

Currently this isn't a configured option as it is easy to override or implement yourself.

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email asumi0198@gmail.com instead of using the issue tracker.

assumilhig / laravel-key-generator

Maintainers

Details