oxsepaibanvalidator.php

Go to the documentation of this file.

<?php

class oxSepaIBANValidator
{

    const IBAN_ALGORITHM_MOD_VALUE = 97;

    protected $_aCodeLengths = array();

    public function isValid($sIBAN)
    {
        $blValid = false;
        $sIBAN = strtoupper(trim($sIBAN));

        if ($this->_isLengthValid($sIBAN)) {
            $blValid = $this->_isAlgorithmValid($sIBAN);
        }

        return $blValid;
    }

    public function isValidCodeLengths($aCodeLengths)
    {
        $blValid = false;

        if ($this->_isNotEmptyArray($aCodeLengths)) {
            $blValid = $this->_isEachCodeLengthValid($aCodeLengths);
        }

        return $blValid;
    }

    public function setCodeLengths($aCodeLengths)
    {
        if ($this->isValidCodeLengths($aCodeLengths)) {
            $this->_aCodeLengths = $aCodeLengths;

            return true;
        } else {
            return false;
        }

    }

    public function getCodeLengths()
    {
        return $this->_aCodeLengths;
    }


    protected function _isLengthValid($sIBAN)
    {
        $iActualLength = getStr()->strlen($sIBAN);

        $iCorrectLength = $this->_getLengthForCountry($sIBAN);

        return !is_null($iCorrectLength) && $iActualLength === $iCorrectLength;
    }


    protected function _getLengthForCountry($sIBAN)
    {
        $aIBANRegistry = $this->getCodeLengths();

        $sCountryCode = getStr()->substr($sIBAN, 0, 2);

        $iCorrectLength = (isset ($aIBANRegistry[$sCountryCode])) ? $aIBANRegistry[$sCountryCode] : null;

        return $iCorrectLength;
    }

    protected function _isAlgorithmValid($sIBAN)
    {
        $sIBAN = $this->_moveInitialCharactersToEnd($sIBAN);

        $sIBAN = $this->_replaceLettersToNumbers($sIBAN);

        return $this->_isIBANChecksumValid($sIBAN);
    }

    protected function _moveInitialCharactersToEnd($sIBAN)
    {
        $oStr = getStr();

        $sInitialChars = $oStr->substr($sIBAN, 0, 4);
        $sIBAN = $oStr->substr($sIBAN, 4);
        $sIBAN = $sIBAN . $sInitialChars;

        return $sIBAN;
    }

    protected function _replaceLettersToNumbers($sIBAN)
    {
        $aReplaceArray = array(
            'A' => 10,
            'B' => 11,
            'C' => 12,
            'D' => 13,
            'E' => 14,
            'F' => 15,
            'G' => 16,
            'H' => 17,
            'I' => 18,
            'J' => 19,
            'K' => 20,
            'L' => 21,
            'M' => 22,
            'N' => 23,
            'O' => 24,
            'P' => 25,
            'Q' => 26,
            'R' => 27,
            'S' => 28,
            'T' => 29,
            'U' => 30,
            'V' => 31,
            'W' => 32,
            'X' => 33,
            'Y' => 34,
            'Z' => 35
        );

        $sIBAN = str_replace(
            array_keys($aReplaceArray),
            $aReplaceArray,
            $sIBAN
        );

        return $sIBAN;
    }

    protected function _isIBANChecksumValid($sIBAN)
    {
        $blValid = true;

        $sModulus = bcmod($sIBAN, self::IBAN_ALGORITHM_MOD_VALUE);
        if ((int) $sModulus != 1) {
            $blValid = false;
        }

        return $blValid;
    }

    protected function _isNotEmptyArray($aCodeLengths)
    {
        return is_array($aCodeLengths) && !empty($aCodeLengths);
    }

    protected function _isEachCodeLengthValid($aCodeLengths)
    {
        $blValid = true;

        foreach ($aCodeLengths as $sCountryAbbr => $iLength) {

            if (!$this->_isCodeLengthKeyValid($sCountryAbbr) ||
                !$this->_isCodeLengthValueValid($iLength)
            ) {

                $blValid = false;
                break;
            }

        }

        return $blValid;
    }

    protected function _isCodeLengthKeyValid($sCountryAbbr)
    {
        return (int) preg_match("/^[A-Z]{2}$/", $sCountryAbbr) !== 0;
    }

    protected function _isCodeLengthValueValid($iLength)
    {
        return is_numeric($iLength) && (int) preg_match("/\./", $iLength) !== 1;
    }
}