Download the PHP package elgigi/iban without Composer
On this page you can find all versions of the php package elgigi/iban. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package iban
Short Description Library to manipulate IBAN and BBAN of countries
License MIT
Informations about the package iban
Iban
PHP Library to manipulate IBAN and BBAN of countries, with validation, parsing, JSON representation...
Installation
You can install the library with Composer:
Usage
Parsing
You can parse an IBAN with Iban::parse()
method:
Or a BBAN with Bban::parse()
method:
IBAN and BBAN
Iban object is composed of 2 parts:
\ElGigi\Iban\Bban
object (representation of a BBAN)- Check digits
Bban
object is composed of multiple properties:
- Bank identifier
- Branch identifier [^1]
- Account number
- Check digits [^1]
- Currency [^1]
- Additional digits [^1]
- ...
[^1]: Depends on banks and countries
Both object have format()
method to have a string representation of object.
This method accept a boolean parameter to have the "condensed" representation (without spaces).
JSON
For IBAN, the JSON serialization give the IBAN string representation:
For BBAN, it's little different because, we need the country to build the BBAN object again, so the JSON representation is:
After is simple to use parse()
methods of classes to build objects again.
Validation
Validation of IBAN
Call Iban::isValid():bool
method to known if IBAN is valid.
Or use IbanValidation::validate(): bool
static method to valid an IBAN object or string representation.
Also, you can construct an IBAN from BBAN without check digits, library guess them, example:
Validation of BBAN
Depends on banks and countries, BBAN validation is available with method Bban::isValid()
Or uses BbanValidation::validate(): bool
static method to valid a BBAN object or string representation.
In case of bank haven't control on BBAN, the method return always TRUE.
Country
An IBAN is associated to a country. A country is represented by Country
enum.
All countries with IBAN support are listed.
You can also use helpers static methods:
Country::sepaMembers(): array
: list of countries SEPA membersCountry::from(string $iso): Country
: country enum value from ISO code
Or methods with country value (FR in example):
Country::FR->isSepaMember(): bool
: country is SEPA member?Country::FR->getCurrency(): Currency
: main currency of countryCountry::FR->getLanguage(): Language|Language[]
: language(s) of countryCountry::FR->getLocale(): string|string[]
: locale(s) of countryCountry::FR->getIbanRegex(): string
: IBAN regex of country
Language
Language
enum is a representation of languages of countries.
To find whose countries speak a language, you can use helper method:
Language::fr->getCountries(): Country[]
Currency
Currency
enum is a representation of currency of countries.
To find whose countries have currency, you can use helper method:
Currency::fr->getCountries(): Country[]