/php-mt940

A mt940 parser in PHP

Primary LanguagePHPMIT LicenseMIT

Latest Stable Version Total Downloads License

Scrutinizer Quality Score Build Status wercker status

php-mt940?

The php-mt940 package provides a lightweight parser for MT940 format which is used by SWIFT. The output is transformed into easy to use dataclasses Transaction_banking which itself contains Statement_banking objects. Pretty straight forward.

Requirements

  • At least PHP 7

Installation

If composer is not yet on your system, follow the instructions on getcomposer.org to do so.

To add this dependency to your project, simply run the following command from the root of your project:

composer require kingsquare/php-mt940

This ensures that you install the latest stable release.

How to use the parser?

I've attached a simple script in the examples directory to explain it a bit more in detail, but after loading the required classes, the usage should be pretty simple:

<?php
// ... load everything ... //

// instantiate the actual parser
// and parse them from a given file, this could be any file or a posted string
$parser = new \Kingsquare\Parser\Banking\Mt940();
$tmpFile = __DIR__.'/test.mta';
$parsedStatements = $parser->parse(file_get_contents($tmpFile));
?>

Included engines

Currently the following engines are included:

Custom engines

To override engines or just try a one-off engine on a file, you can pass an engine into the parse-method:

<?php
// ... load everything ... //

class MyCustomMt940Engine extends \Kingsquare\Parser\Banking\Mt940\Engine {
    // add your overrides / overloads and custom logic here
}

// instantiate the actual parser
// and parse them from a given file, this could be any file or a posted string
$parser = new \Kingsquare\Parser\Banking\Mt940();
$engine = new MyCustomMt940Engine();
$tmpFile = __DIR__.'/test.mta';
$parsedStatements = $parser->parse(file_get_contents($tmpFile), $engine);
?>

Known issues

I've provided unittests but please take a look at the github issue tracker for the latest ideas's, issues or other stuff..

Future plans

I do intend to add new engines or keep everything running smoothly, but since i don't have access to any more test files, it's hard to add new engines ;) The unknown engine should work or atleast give some idea as to where different banks diverge from the standard. If you do have any ideas, examples or new banks that you'd like to see incorporated, please don't hesitate and send me an issue / pullrequest!

Contact

This is GitHub, you know where to find me :)

License

PHP-MT940 is licensed under the MIT License - see the LICENSE file for details