Skip to content

Latest commit

 

History

History
105 lines (76 loc) · 4.39 KB

README.md

File metadata and controls

105 lines (76 loc) · 4.39 KB
Raw

SwissPaymentSlipFpdf - Swiss Payment Slips with FPDF

Travis Build Status Scrutinizer CI Build Status Scrutinizer CI Code Coverage Scrutinizer CI Code Quality Total Downloads Latest Stable Version

Do you need to create Swiss payment slips (called ESR) as PDF files in a project of yours? Then you found the right place, read on...

By the way if you don't like FPDF or don't want to use it for whatever reason, checkout SwissPaymentSlipTcpdf.

How to use

Just install the package (see Installation) and check out the contained examples in the examples folder.

How to extend for custom needs

[TODO] If you need help, ask for help.

Installation

Requirements

Composer

Just install composer on your system, if not already there. Then create a composer.json file in your project's root folder and copy the following into it:

{
    "require": {
        "swiss-payment-slip/swiss-payment-slip-fpdf": "*"
    }
}

After that you can install the package using

$ php composer.phar install

in your project's root folder.

Background Story

In february 2013 I was looking for a solution to create swiss payment slips for a project I had to do at my work place. After a short Google search I came across Manuel Reinhard's blog post about the class he made for that. On his Github project's page I found Peter Siska's pull request. His pull request introduced PSR-0 compatibility and he created a composer package on Packagist. So I tried Peter's version and it suited my basic needs.

BUT since the customer I was working for used custom designed payment slips I couldn't use Manuel's/Peter's script since it wasn't flexible enough. Now I had to decide whether I want to "just" change the script to fit my needs or to rewrite it and make it as flexible as possible. I decided myself for the latter.

TODOs

  • Improve code documentation
  • Add more examples/improve existing ones
  • Write tests
  • Release the stable release of the API

Submitting bugs and feature requests

Bugs and feature request are tracked on GitHub.

Author

This project was created by Marc Würth. See Background Story for more details.

License

SwissPaymentSlipFpdf is licensed under the MIT License. See the LICENSE file for details.

Thanks to