README

This package provides a simple unique code generator with optional configurations.

Installation

You can install the package via composer:

composer require kaantanis/coderator

You can publish the config file with:

php artisan vendor:publish --tag="coderator-config"

This is the contents of the published config file:

return [
    'default_length' => 6,
];

Usage

$coderator = new \KaanTanis\Coderator\Coderator();

$my_code = $coderator->model(\App\Models\Product:class)
    ->field('code') // required. For create unique code
    ->prefix('#PR') // optional. default is empty
    ->length(6) // optional. except prefix, default is 6
    ->generate(); // returns a unique code
// $my_code = '#PRAY81QH'

// Without optional configurations
$my_code = $coderator->model(\App\Models\Product:class)
    ->field('code') // required. For create unique code
    ->generate(); // returns a unique code    
// $my_code = '8EYQHG'

// Now you can use it this unique code for your model. E.g. Product model
Product::create([
    'code' => $my_code, // absolute unique code 8EYQHG
    ...
]);

Changelog

Please see CHANGELOG for more information on what has changed recently.

Roadmap

• Suffix option
• Maybe created codes will be stored in a database table with a model and field name. So, it will be faster to generate a unique code.
• More tests
• More configurations
• More coffee

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• KaanTanis
• All Contributors

License

The MIT License (MIT). Please see License File for more information.