HumHub Documentation (unofficial)

BusinessIdentifierCode extends AbstractValidator

in package

• Application

Table of Contents

Constants

INVALID  = 'valueNotBic'

NOT_STRING  = 'valueNotString'

NOT_VALID_COUNTRY  = 'valueNotCountry'

ISO_COUNTRIES  = ['AD', 'AE', 'AF', 'AG', 'AI', 'AL', 'AM', 'AO', 'AQ', 'AR', 'AS', 'AT', 'AU', 'AW', 'AX', 'AZ', 'BA', 'BB', 'BD', 'BE', 'BF', 'BG', 'BH', 'BI', 'BJ', 'BL', 'BM', 'BN', 'BO', 'BQ', 'BQ', 'BR', 'BS', 'BT', 'BV', 'BW', 'BY', 'BZ', 'CA', 'CC', 'CD', 'CF', 'CG', 'CH', 'CI', 'CK', 'CL', 'CM', 'CN', 'CO', 'CR', 'CU', 'CV', 'CW', 'CX', 'CY', 'CZ', 'DE', 'DJ', 'DK', 'DM', 'DO', 'DZ', 'EC', 'EE', 'EG', 'EH', 'ER', 'ES', 'ET', 'FI', 'FJ', 'FK', 'FM', 'FO', 'FR', 'GA', 'GB', 'GD', 'GE', 'GF', 'GG', 'GH', 'GI', 'GL', 'GM', 'GN', 'GP', 'GQ', 'GR', 'GS', 'GT', 'GU', 'GW', 'GY', 'HK', 'HM', 'HN', 'HR', 'HT', 'HU', 'ID', 'IE', 'IL', 'IM', 'IN', 'IO', 'IQ', 'IR', 'IS', 'IT', 'JE', 'JM', 'JO', 'JP', 'KE', 'KG', 'KH', 'KI', 'KM', 'KN', 'KP', 'KR', 'KW', 'KY', 'KZ', 'LA', 'LB', 'LC', 'LI', 'LK', 'LR', 'LS', 'LT', 'LU', 'LV', 'LY', 'MA', 'MC', 'MD', 'ME', 'MF', 'MG', 'MH', 'MK', 'ML', 'MM', 'MN', 'MO', 'MP', 'MQ', 'MR', 'MS', 'MT', 'MU', 'MV', 'MW', 'MX', 'MY', 'MZ', 'NA', 'NC', 'NE', 'NF', 'NG', 'NI', 'NL', 'NO', 'NP', 'NR', 'NU', 'NZ', 'OM', 'PA', 'PE', 'PF', 'PG', 'PH', 'PK', 'PL', 'PM', 'PN', 'PR', 'PS', 'PT', 'PW', 'PY', 'QA', 'RE', 'RO', 'RS', 'RU', 'RW', 'SA', 'SB', 'SC', 'SD', 'SE', 'SG', 'SH', 'SI', 'SJ', 'SK', 'SL', 'SM', 'SN', 'SO', 'SR', 'SS', 'ST', 'SV', 'SX', 'SY', 'SZ', 'TC', 'TD', 'TF', 'TG', 'TH', 'TJ', 'TK', 'TL', 'TM', 'TN', 'TO', 'TR', 'TT', 'TV', 'TW', 'TZ', 'UA', 'UG', 'UM', 'US', 'UY', 'UZ', 'VA', 'VC', 'VE', 'VG', 'VI', 'VN', 'VU', 'WF', 'WS', 'YE', 'YT', 'ZA', 'ZM', 'ZW']

List of all country codes defined by ISO 3166-1 alpha-2

KOSOVO_EXCEPTION  = 'XK'

This code is the only one used by SWIFT that is not defined by ISO 3166-1 alpha-2

REGEX_BIC  = '/^[a-z]{4}(?<country>[a-z]{2})[a-z2-9][a-np-z0-9]([0-9a-z]{3})?$/i'

Properties

$messageTemplates  : array<string, string>

$messageVariables  : array<string, mixed>

$options  : array<string, mixed>

$abstractOptions  : AbstractOptions|array<string, mixed>

$defaultTranslator  : TranslatorInterface

Default translation object for all validate objects

$defaultTranslatorTextDomain  : string

Default text domain to be used with translator

$messageLength  : int

Limits the maximum returned length of an error message

$messageTemplates  : array<string|int, string>

$value  : mixed

The value to be validated

Methods

__construct()  : mixed

Abstract constructor for all validators A validator should accept following parameters: - nothing f.e. Validator() - one or multiple scalar values f.e. Validator($first, $second, $third) - an array f.e. Validator(array($first => 'first', $second => 'second', $third => 'third')) - an instance of Traversable f.e. Validator($config_instance)

__get()  : mixed

Magic function returns the value of the requested property, if and only if it is the value or a message variable.

__invoke()  : bool

Invoke as command

getDefaultTranslator()  : TranslatorInterface|null

Get default translation object for all validate objects

getDefaultTranslatorTextDomain()  : string

Get default translation text domain for all validate objects

getMessageLength()  : int

Returns the maximum allowed message length

getMessages()  : array<string, string>

Returns array of validation failure messages

getMessageTemplates()  : array<string, string>

Returns the message templates from the validator

getMessageVariables()  : array<int, string>

Returns an array of the names of variables that are used in constructing validation failure messages

getOption()  : mixed

Returns an option

getOptions()  : array<string, mixed>

Returns all available options

getTranslator()  : TranslatorInterface|null

Return translation object

getTranslatorTextDomain()  : string

Return the translation text domain

hasDefaultTranslator()  : bool

Is there a default translation object set?

hasTranslator()  : bool

Does this validator have its own specific translator?

isTranslatorEnabled()  : bool

Is translation enabled?

isValid()  : bool

Returns true if and only if $value meets the validation requirements

isValueObscured()  : bool

Retrieve flag indicating whether or not value should be obfuscated in messages

setDefaultTranslator()  : void

Set default translation object for all validate objects

setDefaultTranslatorTextDomain()  : void

Set default translation text domain for all validate objects

setMessage()  : $this

Sets the validation failure message template for a particular key

setMessageLength()  : void

Sets the maximum allowed message length

setMessages()  : $this

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.

setOptions()  : $this

Sets one or multiple options

setTranslator()  : $this

Set translation object

setTranslatorEnabled()  : $this

Indicate whether or not translation should be enabled

setTranslatorTextDomain()  : $this

Set translation text domain

setValueObscured()  : $this

Set flag indicating whether or not value should be obfuscated in messages

createMessage()  : null|string

Constructs and returns a validation failure message with the given message key and value.

error()  : void

getValue()  : mixed

Returns the validation value

setValue()  : void

Sets the value to be validated and clears the messages and errors arrays

translateMessage()  : string

Translate a validation message

isSwiftValidCountry()  : bool