jakubzapletal / bank-statements
The PHP library to parse bank account statements
Installs: 4 090
Dependents: 0
Suggesters: 0
Security: 0
Stars: 30
Watchers: 8
Forks: 16
Open Issues: 5
Requires
- php: >=5.3.0
- symfony/css-selector: ~2.4
- symfony/dom-crawler: ~2.4
Requires (Dev)
- phpunit/phpunit: ~4.0
- satooshi/php-coveralls: ^1.0.0
- squizlabs/php_codesniffer: ~2.2
This package is not auto-updated.
Last update: 2024-10-26 15:57:49 UTC
README
This is a PHP library to parse bank account statements. The purpose of this library is to simplify bank statements processing
and usage in your application in more standardized way. The parser result is an instance of:
JakubZapletal\Component\BankStatement\Statement\StatementInterface
containing detail information
about a statement and an array of JakubZapletal\Component\BankStatement\Statement\Transaction\TransactionInterface
with further
information about transactions.
Supported formats/bank list
- ABO (
*.gpc
) [doc] - Česká spořitelna (CZ):
JakubZapletal\Component\BankStatement\Parser\ABO\CeskaSporitelnaCZParser
- ČSOB (CZ):
JakubZapletal\Component\BankStatement\Parser\ABOParser
- Fio banka (CZ):
JakubZapletal\Component\BankStatement\Parser\ABOParser
- GE Money Bank (CZ):
JakubZapletal\Component\BankStatement\Parser\ABOParser
- Komerční banka (CZ), alias KM format:
JakubZapletal\Component\BankStatement\Parser\ABOParser
- Raiffeisenbank (CZ):
JakubZapletal\Component\BankStatement\Parser\ABOParser
- XML
- ČSOB (CZ) [doc]:
JakubZapletal\Component\BankStatement\Parser\XML\CSOBCZParser
- CSV
Installation
Note that Bank Statements is PSR-4 compliant:
Composer
If you don't have Composer install it:
$ curl -s https://getcomposer.org/installer | php
Add jakubzapletal/bank-statements
to composer.json
:
$ composer require "jakubzapletal/bank-statements:1.0.*@dev"
Usage
Parsing of each format is provided by a class implementing:
JakubZapletal\Component\BankStatement\Parser\ParserInterface
Thanks to the interface we can rely on two main public methods: parseFile
and parseContent
.
parseFile
expects as an argument a path to file and then processes the parsingparseContent
expects as an argument a string of content and then processes the parsing
Both methods return a class implementing:
JakubZapletal\Component\BankStatement\Statement\StatementInterface
The statement class includes transaction items, which are classes implementing:
JakubZapletal\Component\BankStatement\Statement\Transaction\TransactionInterface
This behaviour ensures the same approach to the parsing and results for all parsers.
All abstract classes and standard classes are easily extendable, allowing implement parsing process of any data.
The basic statement class:
JakubZapletal\Component\BankStatement\Statement\Statement
implements Countable
and Iterator
, so we can call function count()
on it's instances or traverse them using foreach()
.
Keep in mind that transactions of the statements are used. If you need more functionality in the statement class,
I recommend extend this class.
Examples
The parsing:
use JakubZapletal\Component\BankStatement\Parser\ABOParser; $parser = new ABOParser(); // by path to file $path = '/path/to/file'; $statement = $parser->parseFile($path); // by content $content = 'string of data'; $statement = $parser->parseContent($content);
Manipulation with the statement:
echo count($statement); // echo count of transaction items foreach ($statement as $transaction) { // do something with each transaction } echo $statement->getAccountNumber(); // echo an account number of the statement
Contributing
Contributions are welcome! Please see the Contribution Guidelines.