Skip to content

🏦 A small library for validating International BankAccount Numbers (IBANs)

License

Notifications You must be signed in to change notification settings

romanmatyus/iban-validation

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

77 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

iban-validation

A small library for validating International Bankaccount Numbers (IBANs) based on the IBAN Registry provided by SWIFT. See https://www.swift.com/standards/data-standards/iban for more information.

Build Status PHP Version

Total Downloads Latest Stable Version Latest Unstable Version License

Development status

This library is ready to use. The Iban validation should be fine, but there is no warranty. Please use it at your own risk.


Features

  • full country support of IBAN validation based on SWIFT Registry
  • customizable violation messages
  • simple to use object oriented api
  • high test coverage
  • DIC friendly

Installation

To install jschaedl/iban-validation via composer use

$ composer require jschaedl/iban-validation

You can see this library on Packagist.


Iban Validation

<?php

use Iban\Validation\Validator;
use Iban\Validation\Iban;

$iban = new Iban('DE89 3704 0044 0532 0130 00');
$validator = new Validator();

if (!$validator->validate($iban)) {
    foreach ($validator->getViolations() as $violation) {
        echo $violation;
    }
}

You can also customize the violation messages by providing them via configuration. Just create a Validator passing a config array as constructor argument.

<?php

use Iban\Validation\Validator;

$validator = new Validator([
    'violation.unsupported_country' => 'The requested country is not supported!',
    'violation.invalid_length' => 'The length of the given Iban is not valid!',
    'violation.invalid_country_code' => 'The country code of the given Iban is not valid!',
    'violation.invalid_format' => 'The format of the given Iban is not valid!',
    'violation.invalid_checksum' => 'The checksum of the given Iban is not valid!',
]);

Iban Information

<?php

use Iban\Validation\Iban;
use Iban\Validation\CountryInfo;

$iban = new Iban('IBAN DE89 3704 0044 0532 0130 00');
$iban->getCountryCode(); // 'DE'
$iban->getChecksum(); // '89'
$iban->getBban(); // '370400440532013000'
$iban->format(Iban::FORMAT_PRINT); // 'DE89 3704 0044 0532 0130 00'
$iban->format(Iban::FORMAT_ELECTRONIC); // 'DE89370400440532013000'
$iban->format(Iban::FORMAT_ANONYMIZED); // 'XXXXXXXXXXXXXXXXXX3000'

$countryInfo = new CountryInfo('DE');
$countryInfo->getCountryName(); // 'Germany'
$countryInfo->getIbanStructureSwift(); // 'DE2!n8!n10!n'
$countryInfo->getBbanStructureSwift(); // '8!n10!n'
$countryInfo->getIbanRegex(); // '/^DE\d{2}\d{8}\d{10}$/'
$countryInfo->getBbanRegex(); // '/^\d{8}\d{10}$/'
$countryInfo->getIbanLength(); // 22
$countryInfo->getBbanLength(); // 18
$countryInfo->getIbanPrintExample(); // 'DE89 3704 0044 0532 0130 00'
$countryInfo->getIbanElectronicExample(); // 'DE89370400440532013000'

How to contribute

If you want to fix some bugs or want to enhance some functionality, please fork the master branch and create your own development branch. Then fix the bug you found or add your enhancements and make a pull request. Please commit your changes in tiny steps and add a detailed description on every commit.

Unit Testing

All pull requests must be accompanied by passing unit tests. This repository uses phpunit and Composer. You must run composer --dev install to install this package's dependencies. You can run the tests via:

$ vendor/bin/phpunit

Author

Jan Schädlich

Contributors

License

MIT License


Release Status

2018-12-14: Version 1.2 has been released.

  • updated iban registry file to 201812r80
  • changed minimum version for yaml and option-resolver component to ^3.4|^4.1

2018-09-14: Version 1.1 has been released.

  • introduced FORMAT_ANONYMIZED IBAN format: $iban->format(Iban::FORMAT_ANONYMIZED)
  • cleanup IBAN creation logic
  • cleanup project structure

2018-08-19: Version 1.0 has been released.

About

🏦 A small library for validating International BankAccount Numbers (IBANs)

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 100.0%