oxSepaIBANValidator Class Reference

Collaboration diagram for oxSepaIBANValidator:

List of all members.

Public Member Functions
	isValid ($sIBAN)
	isValidCodeLengths ($aCodeLengths)
	setCodeLengths ($aCodeLengths)
	getCodeLengths ()
Public Attributes
const	IBAN_ALGORITHM_MOD_VALUE = 97
Protected Member Functions
	_isLengthValid ($sIBAN)
	_getLengthForCountry ($sIBAN)
	_isAlgorithmValid ($sIBAN)
	_moveInitialCharactersToEnd ($sIBAN)
	_replaceLettersToNumbers ($sIBAN)
	_isIBANChecksumValid ($sIBAN)
	_isNotEmptyArray ($aCodeLengths)
	_isEachCodeLengthValid ($aCodeLengths)
	_isCodeLengthKeyValid ($sCountryAbbr)
	_isCodeLengthValueValid ($iLength)
Protected Attributes
	$_aCodeLengths = array()

---

Detailed Description

SEPA (Single Euro Payments Area) validation class

Definition at line 7 of file oxsepaibanvalidator.php.

---

Member Function Documentation

oxSepaIBANValidator._getLengthForCountry

(

$

sIBAN

)

[protected]

Gets length for country.

Parameters:

string

$sIBAN IBAN

Returns:

null

Definition at line 108 of file oxsepaibanvalidator.php.

oxSepaIBANValidator._isAlgorithmValid

(

$

sIBAN

)

[protected]

Checks if IBAN is valid according to checksum algorithm

Parameters:

string

$sIBAN IBAN

Returns:

bool

Definition at line 126 of file oxsepaibanvalidator.php.

oxSepaIBANValidator._isCodeLengthKeyValid

(

$

sCountryAbbr

)

[protected]

Checks if country code is valid

Parameters:

string

$sCountryAbbr Country abbreviation

Returns:

bool

Definition at line 264 of file oxsepaibanvalidator.php.

oxSepaIBANValidator._isCodeLengthValueValid

(

$

iLength

)

[protected]

Checks if value is numeric and does not contain whitespaces

Parameters:

integer

$iLength Length

Returns:

bool

Definition at line 276 of file oxsepaibanvalidator.php.

oxSepaIBANValidator._isEachCodeLengthValid

(

$

aCodeLengths

)

[protected]

Checks if each code length is valid.

Parameters:

array

$aCodeLengths Code lengths

Returns:

bool

Definition at line 238 of file oxsepaibanvalidator.php.

oxSepaIBANValidator._isIBANChecksumValid

(

$

sIBAN

)

[protected]

Interpret the string as a decimal integer and compute the remainder of that number on division by 97.

Parameters:

string

$sIBAN IBAN

Returns:

bool

Definition at line 207 of file oxsepaibanvalidator.php.

oxSepaIBANValidator._isLengthValid

(

$

sIBAN

)

[protected]

Check if the total IBAN length is correct as per country. If not, the IBAN is invalid.

Parameters:

string

$sIBAN IBAN

Returns:

bool

Definition at line 91 of file oxsepaibanvalidator.php.

oxSepaIBANValidator._isNotEmptyArray

(

$

aCodeLengths

)

[protected]

Checks if Code length is non empty array

Parameters:

array

$aCodeLengths Code lengths

Returns:

bool

Definition at line 226 of file oxsepaibanvalidator.php.

oxSepaIBANValidator._moveInitialCharactersToEnd

(

$

sIBAN

)

[protected]

Move the four initial characters to the end of the string.

Parameters:

string

$sIBAN IBAN

Returns:

string

Definition at line 142 of file oxsepaibanvalidator.php.

oxSepaIBANValidator._replaceLettersToNumbers

(

$

sIBAN

)

[protected]

Replace each letter in the string with two digits, thereby expanding the string, where A = 10, B = 11, ..., Z = 35.

Parameters:

string

$sIBAN IBAN

Returns:

string

Definition at line 160 of file oxsepaibanvalidator.php.

oxSepaIBANValidator.getCodeLengths

(

)

Get IBAN length by country data

Returns:

array

Definition at line 78 of file oxsepaibanvalidator.php.

oxSepaIBANValidator.isValid

(

$

sIBAN

)

International bank account number validation

An IBAN is validated by converting it into an integer and performing a basic mod-97 operation (as described in ISO 7064) on it. If the IBAN is valid, the remainder equals 1.

Parameters:

string

$sIBAN code to check

Returns:

bool

Definition at line 24 of file oxsepaibanvalidator.php.

oxSepaIBANValidator.isValidCodeLengths

(

$

aCodeLengths

)

Validation of IBAN registry

Parameters:

array

$aCodeLengths

Returns:

bool

Definition at line 43 of file oxsepaibanvalidator.php.

oxSepaIBANValidator.setCodeLengths

(

$

aCodeLengths

)

Set IBAN Registry

Parameters:

array

$aCodeLengths

Returns:

bool

Definition at line 61 of file oxsepaibanvalidator.php.

---

Member Data Documentation

oxSepaIBANValidator.$_aCodeLengths = array() [protected]

Definition at line 12 of file oxsepaibanvalidator.php.

const oxSepaIBANValidator.IBAN_ALGORITHM_MOD_VALUE = 97

Definition at line 10 of file oxsepaibanvalidator.php.

---

The documentation for this class was generated from the following file:

• core/oxsepaibanvalidator.php