-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
11 additions
and
142 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,143 +1,4 @@ | ||
| # iban-validation | ||
|
|
||
| [](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md) | ||
|
|
||
| [](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md) | ||
|
|
||
| ## A message to Russian 🇷🇺 people | ||
|
|
||
| If you currently live in Russia, please read [this message](./ToRussianPeople.md). | ||
|
|
||
| ## Purpose | ||
|
|
||
| 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. | ||
|
|
||
| [](https://github.com/jschaedl/iban-validation) | ||
|  | ||
| [](https://packagist.org/packages/jschaedl/iban-validation) | ||
| [](https://packagist.org/packages/jschaedl/iban-validation) | ||
| [](https://packagist.org/packages/jschaedl/iban-validation) | ||
| [](https://packagist.org/packages/jschaedl/iban-validation) | ||
|
|
||
|
|
||
| ## 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](https://getcomposer.org/) use | ||
|
|
||
| ```sh | ||
| $ composer require jschaedl/iban-validation | ||
| ``` | ||
|
|
||
| You can see this library on [Packagist](https://packagist.org/packages/jschaedl/iban-validation). | ||
|
|
||
| --- | ||
|
|
||
| ## Iban Validation | ||
|
|
||
| ```php | ||
| <?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 | ||
| <?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_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 | ||
| <?php | ||
|
|
||
| use Iban\Validation\Iban; | ||
| use Iban\Validation\CountryInfo; | ||
|
|
||
| $iban = new Iban('IBAN DE89 3704 0044 0532 0130 00'); | ||
| $iban->countryCode(); // 'DE' | ||
| $iban->checksum(); // '89' | ||
| $iban->bban(); // '370400440532013000' | ||
| $iban->bbanBankIdentifier(); // '37040044' | ||
| $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 one of the release branches 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: | ||
|
|
||
| ```sh | ||
| $ vendor/bin/phpunit | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## Author | ||
|
|
||
| [Jan Schädlich](https://www.linkedin.com/in/janschaedlich) | ||
|
|
||
| [Contributors](https://github.com/jschaedl/iban-validation/graphs/contributors) | ||
|
|
||
| ## License | ||
|
|
||
| MIT License | ||
| WARNING: The major version `1` of jschaedl/iban-validation is not maintained anymore. The last bugfix version of major version `1` is `1.8.4`. | ||
| Please check the [https://github.com/jschaedl/iban-validation/blob/master/CHANGELOG.md](CHANGELOG) and upgrade to version `2.0.0`. |