About BAV

BAV (bank account validator) is a validation library for German bank accounts., _(*1)

Installation

Use Composer:, _(*2)

{
    "require": {
        "malkusch/bav": "^1"
    }
}

Configuration

You can use BAV out of the box. BAV comes with a ready to play default configuration (DefaultConfiguration):, _(*3)

UTF-8 encoding (if supported), _(*4)
FileDataBackendContainer. I.e. it uses binary search on the file from the Bundesbank. Note that this data backend uses the directory bav/data for install and update operations. You have to make sure that this directory is writable., _(*5)
automatic installation. You don't have to call any installation script. The container will download the Bundesbank file upon the first execution., _(*6)
update plan which triggers an E_USER_NOTICE if the Bundesbank file is outdated., _(*7)

You can define your own configuration by calling ConfigurationRegistry::setConfiguration() or preferably creating the file bav/configuration.php which returns a Configuration object:, _(*8)

namespace malkusch\bav;

$configuration = new DefaultConfiguration();

$pdo = new \PDO("mysql:host=localhost;dbname=test;charset=UTF8");
$configuration->setDataBackendContainer(new PDODataBackendContainer($pdo));

$configuration->setUpdatePlan(new AutomaticUpdatePlan());

return $configuration;

Update

The Bundesbank releases new files for March, June, September and December. BAV needs those new files. You have several possiblities to update bav:, _(*9)

Script

Call bin/bav-update.php., _(*10)

Programmatically

use malkusch\bav\BAV;

$bav = new BAV();
$bav->update();

Automatic

Enable automatic updates with AutomaticUpdatePlan in your bav/configuration.php:, _(*11)

namespace malkusch\bav;

$configuration = new DefaultConfiguration();
$configuration->setUpdatePlan(new AutomaticUpdatePlan());

return $configuration;

This automatic update plan will perform long running update operations as a shutdown hook. I.e. it won't bother users during normal operations., _(*12)

Usage

You can use BAV with the api facade BAV:, _(*13)

BAV::isValidBank($bankID): Returns true for existing bank ids., _(*14)
BAV::isValidBankAccount($bankID, $account): Returns true for existing accounts of an existing bank., _(*15)
BAV::isValidAccount($account): This method validates an account against the bank of the last isValidBank() call., _(*16)
BAV::getValidBankFilterCallback(): Returns a callback for filter bank validation., _(*17)
BAV::getValidAccountFilterCallback(): Returns a callback for filter account validation. The account filter needs to be called after the bank filter., _(*18)
BAV::getMainAgency(): Returns the main agency of a bank., _(*19)
BAV::getAgencies(): Returns further agencies. The main agency is not included in this list. This list can be empty., _(*20)

An Agency object has the fields:, _(*21)

Example

use malkusch\bav\BAV;

$bav = new BAV();
$bankID  = "10000000";
$account = "1234567890"

// check for a bank
var_dump(
    $bav->isValidBank($bankID)
);

// check for a bank account
var_dump(
    $bav->isValidBankAccount($bankID, $account)
);

// filter validation
var_dump(
    filter_var($bankID, FILTER_CALLBACK, $bav->getValidBankFilterCallback()),
    filter_var($account, FILTER_CALLBACK, $bav->getValidAccountFilterCallback())
);

// Get informations about a bank
$agency = $bav->getMainAgency($bankID);
echo "{$agency->getName()} {$agency->getCity()}\n";

See also bav/docs/example.php., _(*28)

Optional Dependencies

You may have:, _(*29)

CURL: If you provide bav/data/banklist.txt you don't need CURL., _(*30)
mbstring: BAV works with unicode encoding. Your PHP must have support compiled in the mb_* functions. If these functions are missing BAV works only with the ISO-8859-15 encoding., _(*31)
PDO: If you intend to use a DBS you need to use PDODataBackendContainer. PDODataBackendContainer needs a PDO support compiled in PHP., _(*32)
doctrine/orm: You can use DoctrineBackendContainer which uses doctrine as data backend., _(*33)

License and authors

This project is free and under the WTFPL. So do what ever you want. But it would be nice to leave a note about the authors., _(*34)

The author of the original project which gave the idea to this project is Björn Wilmsmann. Responsable for this project is Markus Malkusch markus@malkusch.de., _(*35)