loskoderos/faktura-php

Faktura - HTML/PDF Invoice Generator

Faktura PHP

Generate pretty PDF invoices in PHP, _(*1)

What is this?

Faktura in polish means invoice and this library is created to render pretty invoices in PHP., _(*2)

Faktura is a simple standalone PHP library for rendering PDF invoices in PHP. You can easily integrate it into your own project using standard tools like composer. Currently, Faktura depends on xvfb and wkhtmltopdf to create PDF files. Faktura has builtin rendering based on native PHP templates that can be customized with plugin functions., _(*3)

Sample PDF invoice: https://github.com/loskoderos/faktura-php/blob/master/examples/simple_invoice_pl.pdf , _(*4)

Basic usage

Faktura is simple to use and it lets you to map an invoice structure and customize it to your needs., _(*5)

use LosKoderos\Faktura\Faktura;

$faktura = new Faktura();

$invoice = $faktura->newInvoice();
$invoice->setInvoiceReference('INV/123/2018');

//...

$invoice->newItem()
    ->setDescription('Some item on the invoice')
    ->setUnitNetPrice(123)
    ;

//...

$faktura->setTemplate('path_to_your_invoice_template.phtml');
$faktura->export($invoice, 'invoice.pdf');

Have a look into examples folder to see the full example: https://github.com/loskoderos/faktura-php/blob/master/examples/simple_invoice_pl.php, _(*6)

Features

• Standalone library, no external PHP frameworks needed.
• Easily integrates with others.
• Builtin templating using native PHP templates.
• Builtin support for UTF-8 and images.
• Extend template rendering with custom plugin functions.
• Invoice structure can be customized, you can add custom fields to fit your needs.
• Invoice can be serialized to save it in database for accounting purposes.
• You can easily customize the library with overrides.

Installation

Faktura is still under development, however if you want to try it out you can easily install it with Composer:, _(*7)

composer config minimum-stability dev
composer require loskoderos/faktura-php:dev-master

Before you use it, you need to take care of a couple od system dependencies. You'll need to install Xvfb and Wkhtmltopdf, on Ubuntu run:, _(*8)

sudo apt-get install xvfb wkhtmltopdf

To confirm, all is good, run the example:, _(*9)

php examples/simple_invoice_pl.php

It should finish without any error and generate examples/simple_invoice_pl.pdf., _(*10)

Contributing

Contributions are welcome, please submit a pull request., _(*11)

License

MIT, _(*12)