2lenet/invoice-bundle

Invoice Bundle

3.1.0 2023-08-28 08:33 UTC

Requires

• php: ^8.1
• cocur/slugify: ^4.0
• gedmo/doctrine-extensions: ^2.4|^3
• symfony/form: ^6.0
• symfony/framework-bundle: ^6.0
• symfony/orm-pack: *
• symfony/validator: ^6.0
• twig/twig: ^3.4

Requires (Dev)

• phpstan/phpstan: ^1.8
• phpstan/phpstan-doctrine: ^1.3
• phpstan/phpstan-mockery: ^1.1
• phpstan/phpstan-phpunit: ^1.1
• phpstan/phpstan-symfony: ^1.2
• phpunit/phpunit: ^9.5
• symfony/console: ^6.0
• symfony/maker-bundle: ^1.0
• symfony/phpunit-bridge: ^5.1

MIT

• 2LE Team

README

This bundle is useful to manage invoice in your project.

Installation

To install the bundle:

composer require 2le/invoice-bundle

Configuration

To configure the bundle, in the doctrine service configuration file ("config/packages/doctrine.yaml"), you have to define which entity will get the role of customer.

For exemple, if you want to use your User entity, you will add this block at the end of file :

config/packages/doctrine.yaml:
    ...
    orm:
        ...
        resolve_target_entities:
            Lle\InvoiceBundle\Model\CustomerInterface: App\Entity\User
            Lle\InvoiceBundle\Model\ProductInterface: App\Entity\Product
            Lle\InvoiceBundle\Model\CustomerInterface: App\Entity\Guest
            Lle\InvoiceBundle\Model\ProductInterface: App\Entity\InvoiceProduct
            Lle\InvoiceBundle\Model\SellerInterface: App\Entity\Establishment
            Lle\InvoiceBundle\Model\InvoiceInterface: App\Entity\Invoice
            Lle\InvoiceBundle\Model\InvoiceLineInterface: App\Entity\InvoiceLine
            Lle\InvoiceBundle\Model\PaymentInterface: App\Entity\Payment
            Lle\InvoiceBundle\Model\PaymentConditionInterface: App\Entity\PaymentCondition
            Lle\InvoiceBundle\Model\PaymentTypeInterface: App\Entity\PaymentType
            Lle\InvoiceBundle\Model\VatRateInterface: App\Entity\VatRate

Then, when the bundle expect a CustomerInterface you can pass an user. Once this listener is configured, Doctrine will know how to replace the customer interface. And that's the same for the Product entity.

To get more info about relationships with abstract classes and interfaces, you can check official Symfony Documentation here

Do not forget to implement methods on your entity using bundle traits and add your custom needs.

class Invoice implements InvoiceInterface
{
    use InvoiceTrait;
    
    ...
}

PDF Parameter

Use PdfGenerator To export invoice in PDF, you have to define paramater in the file "config/packages/lle_invoice.yaml". For example, you can define parameter like that :

lle_invoice:
  # Relative path to image (png or jpg) from root directory
  logo: 'public/image/image.jpg'
  header: 'header \n address'
  footer: 'footer \n info'

logo: Path of image to put on Invoice header

The other fields concern the company who made fixtures.

Usage

In this bundle, there are several services : InvoiceManager, InvoiceLineManager, InvoiceExporter, InvoicePDF. You can use all of them with Dependency Injection. You can use EasyAdmin or EasyAdminPlus to manage this entity.

Invoice Manager

InvoiceManager is a service that let you generate a draft invoice or validate an invoice.

Generate a draft invoice

A draft invoice is an invoice with pre-filled fields.

Example:

    public function index(InvoiceManager $invoiceManager): Response
    {
        ...
        // To get a draft Invoice
        $invoiceManager->generate();    
        ...  
    }

But if you want to get more pre-filled fields, you can pass an entity that implements CustomerInterface :

    public function index(InvoiceManager $invoiceManager): Response
    {
        ...
        // Entity User implements CustomerInterface in this example
        $invoiceManager->generate($user);    
        ...  
    }

Validate an invoice

If you want to validate an invoice, you can use the InvoiceManager. Validate an Invoice set the invoice number, puts current date and set status to "Validate".

Example:

    public function index(InvoiceManager $invoiceManager): Response
    {
        ...
        $invoiceManager->validate($invoice);    
        ...  
    }

Then, you can persist your entity or do whatever you want.

Invoice Exporter

You can export one or more invoice in csv format.

Example:

    public function index(InvoiceExporter $invoiceExporter, Invoice $invoice): Response
    {
        ...
        $invoiceExporter->export([$invoice]);    
        ...  
    }

You can choose the filename with: export([$invoice1, $invoice2], 'invoice_export.csv');