Iban Class Reference

Validates IBAN Numbers (International Bank Account Numbers) More...

Public Member Functions
	__construct ($options=array())
	Sets validator options.
	getCountryCode ()
	Returns the optional country code by ISO 3166-1.
	setCountryCode ($countryCode=null)
	Sets an optional country code by ISO 3166-1.
	allowNonSepa ()
	Returns the optional allow non-sepa countries setting.
	setAllowNonSepa ($allowNonSepa)
	Sets the optional allow non-sepa countries setting.
	isValid ($value)
	Returns true if $value is a valid IBAN.
Public Member Functions inherited from AbstractValidator
	__construct ($options=null)
	Abstract constructor for all validators A validator should accept following parameters:
	getOption ($option)
	Returns an option.
	getOptions ()
	Returns all available options.
	setOptions ($options=array())
	Sets one or multiple options.
	getMessages ()
	Returns array of validation failure messages.
	__invoke ($value)
	Invoke as command.
	getMessageVariables ()
	Returns an array of the names of variables that are used in constructing validation failure messages.
	getMessageTemplates ()
	Returns the message templates from the validator.
	setMessage ($messageString, $messageKey=null)
	Sets the validation failure message template for a particular key.
	setMessages (array $messages)
	Sets validation failure message templates given as an array, where the array keys are the message keys, and the array values are the message template strings.
	__get ($property)
	Magic function returns the value of the requested property, if and only if it is the value or a message variable.
	setValueObscured ($flag)
	Set flag indicating whether or not value should be obfuscated in messages.
	isValueObscured ()
	Retrieve flag indicating whether or not value should be obfuscated in messages.
	setTranslator (Translator\TranslatorInterface $translator=null, $textDomain=null)
	Set translation object.
	getTranslator ()
	Return translation object.
	hasTranslator ()
	Does this validator have its own specific translator?
	setTranslatorTextDomain ($textDomain= 'default')
	Set translation text domain.
	getTranslatorTextDomain ()
	Return the translation text domain.
	setTranslatorEnabled ($flag=true)
	Indicate whether or not translation should be enabled.
	isTranslatorEnabled ()
	Is translation enabled?
Public Member Functions inherited from TranslatorAwareInterface
	setTranslator (TranslatorInterface $translator=null, $textDomain=null)
	Sets translator to use in helper.

Public Attributes
const	NOTSUPPORTED = 'ibanNotSupported'
const	SEPANOTSUPPORTED = 'ibanSepaNotSupported'
const	FALSEFORMAT = 'ibanFalseFormat'
const	CHECKFAILED = 'ibanCheckFailed'

Protected Attributes
	$messageTemplates
	$countryCode
	$allowNonSepa = true
Protected Attributes inherited from AbstractValidator
	$value
	$abstractOptions

Static Protected Attributes
static	$sepaCountries
static	$ibanRegex
Static Protected Attributes inherited from AbstractValidator
static	$defaultTranslator
static	$defaultTranslatorTextDomain = 'default'
static	$messageLength = -1

Additional Inherited Members
Static Public Member Functions inherited from AbstractValidator
static	setDefaultTranslator (Translator\TranslatorInterface $translator=null, $textDomain=null)
	Set default translation object for all validate objects.
static	getDefaultTranslator ()
	Get default translation object for all validate objects.
static	hasDefaultTranslator ()
	Is there a default translation object set?
static	setDefaultTranslatorTextDomain ($textDomain= 'default')
	Set default translation text domain for all validate objects.
static	getDefaultTranslatorTextDomain ()
	Get default translation text domain for all validate objects.
static	getMessageLength ()
	Returns the maximum allowed message length.
static	setMessageLength ($length=-1)
	Sets the maximum allowed message length.
Protected Member Functions inherited from AbstractValidator
	createMessage ($messageKey, $value)
	Constructs and returns a validation failure message with the given message key and value.
	error ($messageKey, $value=null)
	getValue ()
	Returns the validation value.
	setValue ($value)
	Sets the value to be validated and clears the messages and errors arrays.
	translateMessage ($messageKey, $message)
	Translate a validation message.

Detailed Description

Validates IBAN Numbers (International Bank Account Numbers)

Constructor & Destructor Documentation

__construct

(

$options = array()

)

Sets validator options.

Parameters

array | Traversable

$options

OPTIONAL

Member Function Documentation

allowNonSepa

(

)

Returns the optional allow non-sepa countries setting.

Returns

bool

getCountryCode

(

)

Returns the optional country code by ISO 3166-1.

Returns

string|null

isValid

(

$value

)

Returns true if $value is a valid IBAN.

Parameters

string

$value

Returns

bool

Implements ValidatorInterface.

setAllowNonSepa

(

$allowNonSepa

)

Sets the optional allow non-sepa countries setting.

Parameters

bool

$allowNonSepa

Returns

Iban provides a fluent interface

setCountryCode

(

$countryCode = null

)

Sets an optional country code by ISO 3166-1.

Parameters

string | null

$countryCode

Returns

Iban provides a fluent interface

Exceptions

Exception\InvalidArgumentException

Member Data Documentation

$allowNonSepa = true

protected

$countryCode

protected

$ibanRegex

staticprotected

$messageTemplates

protected

Initial value:

= array(
        self::NOTSUPPORTED     => "Unknown country within the IBAN",
        self::SEPANOTSUPPORTED => "Countries outside the Single Euro Payments Area (SEPA) are not supported",
        self::FALSEFORMAT      => "The input has a false IBAN format",
        self::CHECKFAILED      => "The input has failed the IBAN check",
    )

$sepaCountries

staticprotected

Initial value:

= array(
        'AT', 'BE', 'BG', 'CY', 'CZ', 'DK', 'FO', 'GL', 'EE', 'FI', 'FR', 'DE',
        'GI', 'GR', 'HU', 'IS', 'IE', 'IT', 'LV', 'LI', 'LT', 'LU', 'MT', 'MC',
        'NL', 'NO', 'PL', 'PT', 'RO', 'SK', 'SI', 'ES', 'SE', 'CH', 'GB'
    )

const CHECKFAILED = 'ibanCheckFailed'

const FALSEFORMAT = 'ibanFalseFormat'

const NOTSUPPORTED = 'ibanNotSupported'

const SEPANOTSUPPORTED = 'ibanSepaNotSupported'