README

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

Laravel Version 10.*

Description

Title: Laravel Invoice Number Generator

The Laravel Invoice Number Generator is a powerful and flexible package that simplifies the process of generating unique invoice numbers within Laravel applications. It provides a convenient solution for managing invoice numbers, ensuring they are unique, sequential, and customizable according to your specific requirements.

Features:

Unique Invoice Number Generation: The package generates unique invoice numbers to avoid conflicts and ensure accurate record-keeping.

Sequential Numbering: The invoice numbers are generated in a sequential manner, making it easier to track and organize invoices.

Customizable Formats: You can define custom formats for your invoice numbers, allowing you to incorporate various elements such as prefixes, suffixes, date formats, and sequential numbering patterns.

Integration with Laravel Ecosystem: The package seamlessly integrates with Laravel, leveraging its powerful features and ecosystem. It utilizes Laravel's model events and database migrations for easy setup and configuration.

Configurable Options: The package provides various configuration options, including the ability to set the initial invoice number, configure the length of invoice numbers, define prefix and suffix values, and specify the date format.

Multiple Invoice Number Generators: You can create multiple invoice number generators with different configurations to handle specific use cases within your application. For example, you might have separate invoice numbering for different branches or departments.

Extensible and Customizable: The package is designed to be extensible, allowing you to customize its functionality to meet your specific needs. You can override default behaviors, implement your own generation algorithms, or extend existing classes.

Well-documented and Supported: The Laravel Invoice Number Generator package is thoroughly documented, providing clear instructions on installation, configuration, and usage. Additionally, it benefits from an active community and ongoing support to address any issues or questions you may have.

By using the Laravel Invoice Number Generator package, you can streamline your invoicing process, ensure accurate and unique invoice numbers, and improve overall organization and tracking of your financial records.

Installation

You can install the package via composer:

composer require yearul/lara-invoice

You can publish the config file with:

php artisan vendor:publish --tag="lara-invoice-config"

This is the contents of the published config file:

return [

    /* 
    |--------------------------------------------------------------------------
    | Invoice NO Generator Config
    |--------------------------------------------------------------------------
    |
    | This is the config file for Invoice NO generator. You can override
    | this config file by placing it in your application's config directory
    | and change the values as per your need.
    |
    */

     /*
    |--------------------------------------------------------------------------
    | Default Pad Length
    |--------------------------------------------------------------------------
    |
    | If no  pad length is provided to the generate method, this value will be used
    |
    */
    "pad_len" => 5,

    /*
    |--------------------------------------------------------------------------
    | Default Prefix
    |--------------------------------------------------------------------------
    |
    | If no prefix is provided to the generate method, this value will be used
    |
    */
    "prefix" => "YEA",
    /*
    |--------------------------------------------------------------------------
    | Default year and year_val
    |--------------------------------------------------------------------------
    |
    | If no year and year_val is provided to the generate method, this value will be used
    |
    */

    "year" => true,
    "year_val" => date('Y'),

    /*
    |--------------------------------------------------------------------------
    | Default  pad string
    |--------------------------------------------------------------------------
    |
    | If no pad string is provided to the generate method, this value will be used
    |
    */

    "pad_string" => 0,   // 0, #, *, $.......etc
    /*
    |--------------------------------------------------------------------------
    | Default  pad_direction
    |--------------------------------------------------------------------------
    |
    | If no pad_direction is provided to the generate method, this value will be used
    |
    */

    "pad_direction" => STR_PAD_LEFT,   // STR_PAD_LEFT, STR_PAD_RIGHT

];

Optionally, you can publish the views using

php artisan vendor:publish --tag="lara-invoice-views"

Usage

use Yearul\LaraInvoice\LaraInvoice; // import this in the top of the class
 $value = LaraInvoice::generate(2); // 2 is input value
echo $value;  //Output  YEA-2023-00002 
//Generate Method
//  generate($input,  $pad_len = null, $pad_string = null, $prefix = null, $year = null)
 // the generate method received 5 value, $input value is mandatory and others value not mandatory( thoes can get from config file and also Manual Input)

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.

yearul / lara-invoice

Maintainers

Details