abcaeffchen/sepa-documentor

Generates file routing slips and control lists from SEPA file data

2.0.0 2020-04-13 16:36 UTC

This package is auto-updated.

Last update: 2022-09-13 19:13:50 UTC


README

Build Status Latest Stable Version Total Downloads License Gitter

General

SepaDocumentor is a module for Sephpa to create file routing slips and control lists as PDF file(s) while generating SEPA xml files.

Requirements

SepaDocumentor works with PHP 7.2, 7.3, 7.4 and requires mPDF >=7.0. It is an optional module of Sephpa >= 2.0 but you can also use it with other SEPA projects as well.

Installation

Composer

Just add

{
    "require": {
        "abcaeffchen/sepa-documentor": "~2.0"
    }
}

to your composer.json and include the Composer autoloader to your script. If you want to use SepaDocumentor with Sephpa, you also need to add the line "abcaeffchen/sephpa": "~2.0.0"

Direct download

You can download it here on GitHub. You need to make it available in all files, where Sephpa is used. You also have to download mPDF and make it available to SepaDocumentor. It integrates with Sephpa, so you don't have to do anything else.

What do the PDF files contain?

There are two files that can be generated: File Routing Slip and Control Lists.

File Routing Slip

The File Routing Slip contains a summary of the SEPA file. This contains the user name of the creator and ID of the file, the number of transactions and the sum of the transferred money and some more information.

Control List

This contains a detailed list of all transactions that are contained in the SEPA file.

Personalize the PDF files

You can modify the templates in src/templates to change the look of the PDF files. This files also contain the localizations. There are a german and english template included but there is a good chance that the english version is a very bad translations, since I have no clue about finance speak. So I would be happy if someone will check this and send me a correct version :)

How to use

With Sephpa

Just use Sephpa as usual. When you call download or store, set the addDocumentation flag. If you want to download a file, you have to download a zip file that contains the xml file(s) and the documentation files as PDF files.

With other SEPA libraries

Overview

There are four functions you can use:

  • FileRoutingSlip::createText($template, $data): Inserts the $data array into the template. $template can be a path to a template or the name of a default template and it can have any format.
  • FileRoutingSlip::createPDF($template, $data): The same as createText(), but the template needs to be in HTML format.
  • ControlList::createText($template, $data, $transactions): Inserts the $data array into the template and repeats the transaction block as often as needed, each filled with the values from one of the arrays in $transactions $template can be a path to a template or the name of a default template and it can have any format.
  • ControlList::createPDF($template, $data, $transactions): The same as createText(), but the template needs to be in HTML format.

Templates

Templates can have any format. You can use

  • placeholders of the form {{KEYWORD}}, where KEYWORD is a string mating [a-zA-Z0-9_-]+.
  • conditionals
  • {{ifdef KEYWORD}} BODY {{endif KEYWORD}}: BODY is only printed if KEYWORD is set. BODY can contain placeholders and other conditionals as long as the nested conditionals use other keywords.
  • {{ifndef KEYWORD}} BODY {{endif KEYWORD}}: BODY is only printed if KEYWORD is not set. BODY can also contain placehodlers and other conditionals as long as the nested conditionals use other keywords.
  • {{TRANSACTION!}} BLOCK {{/TRANSACTION!}}: This is a spacial command block only allowed for control lists. BLOCK can contain any other placeholders or conditionals. This block will be repeated and interpreted for each transaction. Every unused placeholder will be removed from the output.

Inputs

  • $data is a key => value array, where keys are the placeholders without the braces.
  • $transactions is a array of key => value arrays, one for each transaction.

Not every placeholder needs to be present in the input. Keys without a corresponding placeholder will be ignored.

License

Licensed under the LGPL v3.0 License.