Zend_Validate_Iban Class Reference

Inheritance diagram for Zend_Validate_Iban:

Public Member Functions
	__construct ($locale=null)
	getLocale ()
	setLocale ($locale=null)
	isValid ($value)
Public Member Functions inherited from Zend_Validate_Abstract
	getMessages ()
	getMessageVariables ()
	getMessageTemplates ()
	setMessage ($messageString, $messageKey=null)
	setMessages (array $messages)
	__get ($property)
	getErrors ()
	setObscureValue ($flag)
	getObscureValue ()
	setTranslator ($translator=null)
	getTranslator ()
	hasTranslator ()
	setDisableTranslator ($flag)
	translatorIsDisabled ()

Data Fields
const	NOTSUPPORTED = 'ibanNotSupported'
const	FALSEFORMAT = 'ibanFalseFormat'
const	CHECKFAILED = 'ibanCheckFailed'

Protected Attributes
	$_messageTemplates
	$_locale
	$_ibanregex
Protected Attributes inherited from Zend_Validate_Abstract
	$_value
	$_messageVariables = array()
	$_messageTemplates = array()
	$_messages = array()
	$_obscureValue = false
	$_errors = array()
	$_translator
	$_translatorDisabled = false

Additional Inherited Members
Static Public Member Functions inherited from Zend_Validate_Abstract
static	setDefaultTranslator ($translator=null)
static	getDefaultTranslator ()
static	hasDefaultTranslator ()
static	getMessageLength ()
static	setMessageLength ($length=-1)
Protected Member Functions inherited from Zend_Validate_Abstract
	_createMessage ($messageKey, $value)
	_implodeRecursive (array $pieces)
	_error ($messageKey, $value=null)
	_setValue ($value)
Static Protected Attributes inherited from Zend_Validate_Abstract
static	$_defaultTranslator
static	$_messageLength = -1

Detailed Description

Definition at line 35 of file Iban.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$locale = null

)

Sets validator options

Parameters

string | Zend_Config | Zend_Locale

$locale

OPTIONAL

Definition at line 137 of file Iban.php.

    {
        if ($locale instanceof Zend_Config) {
            $locale = $locale->toArray();
        }

        if (is_array($locale)) {
            if (array_key_exists('locale', $locale)) {
                $locale = $locale['locale'];
            } else {
                $locale = null;
            }
        }

        if (empty($locale)) {
            #require_once 'Zend/Registry.php';
            if (Zend_Registry::isRegistered('Zend_Locale')) {
                $locale = Zend_Registry::get('Zend_Locale');
            }
        }

        if ($locale !== null) {
            $this->setLocale($locale);
        }
    }

Member Function Documentation

getLocale()

getLocale

(

)

Returns the locale option

Returns

string|Zend_Locale|null

Definition at line 168 of file Iban.php.

    {
        return $this->_locale;
    }

isValid()

isValid

(

$value

)

Defined by Zend_Validate_Interface

Returns true if $value is a valid IBAN

Parameters

string

$value

Returns

boolean

Implements Zend_Validate_Interface.

Definition at line 204 of file Iban.php.

    {
        $value = strtoupper($value);
        $this->_setValue($value);

        if (empty($this->_locale)) {
            $region = substr($value, 0, 2);
        } else {
            $region = new Zend_Locale($this->_locale);
            $region = $region->getRegion();
        }

        if (!array_key_exists($region, $this->_ibanregex)) {
            $this->_setValue($region);
            $this->_error(self::NOTSUPPORTED);
            return false;
        }

        if (!preg_match($this->_ibanregex[$region], $value)) {
            $this->_error(self::FALSEFORMAT);
            return false;
        }

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

        $temp = intval(substr($format, 0, 1));
        $len  = strlen($format);
        for ($x = 1; $x < $len; ++$x) {
            $temp *= 10;
            $temp += intval(substr($format, $x, 1));
            $temp %= 97;
        }

        if ($temp != 1) {
            $this->_error(self::CHECKFAILED);
            return false;
        }

        return true;
    }

setLocale()

setLocale

(

$locale = null

)

Sets the locale option

Parameters

string | Zend_Locale

$locale

Exceptions

Zend_Locale_Exception
Zend_Validate_Exception

Returns

Zend_Validate_Date provides a fluent interface

Definition at line 181 of file Iban.php.

    {
        if ($locale !== false) {
            #require_once 'Zend/Locale.php';
            $locale = Zend_Locale::findLocale($locale);
            if (strlen($locale) < 4) {
                #require_once 'Zend/Validate/Exception.php';
                throw new Zend_Validate_Exception('Region must be given for IBAN validation');
            }
        }

        $this->_locale = $locale;
        return $this;
    }

Field Documentation

$_ibanregex

$_ibanregex

protected

Definition at line 64 of file Iban.php.

$_locale

$_locale

protected

Definition at line 57 of file Iban.php.

$_messageTemplates

$_messageTemplates

protected

Initial value:

= array(
        self::NOTSUPPORTED => "Unknown country within the IBAN '%value%'",
        self::FALSEFORMAT  => "'%value%' has a false IBAN format",
        self::CHECKFAILED  => "'%value%' has failed the IBAN check",
    )

Definition at line 46 of file Iban.php.

CHECKFAILED

const CHECKFAILED = 'ibanCheckFailed'

Definition at line 39 of file Iban.php.

FALSEFORMAT

const FALSEFORMAT = 'ibanFalseFormat'

Definition at line 38 of file Iban.php.

NOTSUPPORTED

const NOTSUPPORTED = 'ibanNotSupported'

Definition at line 37 of file Iban.php.

---

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

• vendor/magento/zendframework1/library/Zend/Validate/Iban.php