README

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Installation

You can install the package via composer:

composer require tfsthiagobr98/laravel-naming-series

You can publish and run the migrations with:

php artisan vendor:publish --tag="laravel-naming-series-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="laravel-naming-series-config"

This is the contents of the published config file:

return [
    'database' => [
        'connection' => null,
        'table' => 'naming_series',
    ],
    'split_with' => '.',
    'initial_increment' => 1000,
];

Usage

use TFSThiagoBR98\LaravelNamingSeries\Contracts\HasNamingSeries;
use TFSThiagoBR98\LaravelNamingSeries\Concerns\UsingNamingSeries;

class Contract extends Model implements HasNamingSeries
{
    use UsingNamingSeries;

    /**
     * Indicates if the model uses unique ids.
     *
     * @var bool
     */
    public $usesUniqueIds = true;

    /**
     * Field => Format list for model fields
     *
     * @var array<string,string>
     */
    public static function getSerieList(): array
    {
        return [
            'code' => 'CNT-.YY.MM.####',
        ];
    }

    /**
     * Get the columns that should receive a unique identifier.
     *
     * @return array
     */
    public function uniqueIds()
    {
        return [
            'code' => 'getSeriesField', // your series field
        ];
    }

Avaliable Aliases

The Serie format must be splited in part with . character. For example: CNT-.YY.MM.#### where: CNT- is a literal string, YY and MM is a variable and #### is the sequential number.

#: Numeric Sequence ()
YY: Year (2 Digits)
YYYY: Year (4 Digits)
MM: Month
MM: Day
WW: ISO Week Count
TS: Timestamp (Miliseconds)
TL: Timestamp (Seconds)

Testing

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

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

Credits

License

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

tfsthiagobr98 / laravel-naming-series

Maintainers

Details