Class CreditCard

Responsibility: Validate well-formed credit card number from American Express, Unionpay, Diners Club, Diners Club US, Discover, JCB, Laser, Maestro, Mastercard, Solo, Visa and Mir. Credit card contains several items of metadata, including a hologram, account number, logo, expiration date, security code and the card holder name. The algorithms for verifying the combination of metadata are only known to the issuing company, this validator is only for well-formed credit card number. It also provides an ability to attach callbacks with custom validations.

MvcCore\Ext\Forms\Validator implements MvcCore\Ext\Forms\IValidator

MvcCore\Ext\Forms\Validators\CreditCard

Namespace: MvcCore\Ext\Forms\Validators
Located at ext-form-validator-special/src/MvcCore/Ext/Forms/Validators/CreditCard.php

Methods summary
`public string[] &`	# `GetAllowedTypes( )` Get allowed credit card types. If no allowed credit card types defined, then all credit card types are allowed automatically. Get allowed credit card types. If no allowed credit card types defined, then all credit card types are allowed automatically. Returns string[]
`public MvcCore\Ext\Forms\Validators\CreditCard`	# `SetAllowedTypes( )` Set multiple allowed credit card types. If no allowed credit card types defined, then all credit card types are allowed automatically. This function is dangerous, because it removes all previously defined credit card types to allow. If you only add another credit card type, use: `$validator->AddAllowedTypes();` instead. Example: `$validator->SetAllowedTypes(\MvcCore\Ext\Forms\Validators\CreditCard::VISA, ...);` Set multiple allowed credit card types. If no allowed credit card types defined, then all credit card types are allowed automatically. This function is dangerous, because it removes all previously defined credit card types to allow. If you only add another credit card type, use: `$validator->AddAllowedTypes();` instead. Example: `$validator->SetAllowedTypes(\MvcCore\Ext\Forms\Validators\CreditCard::VISA, ...);` Returns `MvcCore\Ext\Forms\Validators\CreditCard`
`public MvcCore\Ext\Forms\Validators\CreditCard`	# `AddAllowedTypes( )` Add multiple allowed credit card types. If no allowed credit card types defined, then all credit card types are allowed automatically. Example: `$validator->AddAllowedTypes(\MvcCore\Ext\Forms\Validators\CreditCard::VISA, ...);` Add multiple allowed credit card types. If no allowed credit card types defined, then all credit card types are allowed automatically. Example: `$validator->AddAllowedTypes(\MvcCore\Ext\Forms\Validators\CreditCard::VISA, ...);` Returns `MvcCore\Ext\Forms\Validators\CreditCard`
`public MvcCore\Ext\Forms\Validators\CreditCard`	# `AddAllowedType( string $allowedType )` Add allowed credit card type. If no allowed credit card types defined, then all credit card types are allowed automatically. Example: `$validator->AddAllowedType(\MvcCore\Ext\Forms\Validators\CreditCard::VISA);` Add allowed credit card type. If no allowed credit card types defined, then all credit card types are allowed automatically. Example: `$validator->AddAllowedType(\MvcCore\Ext\Forms\Validators\CreditCard::VISA);` Parameters `$allowedType` Allowed credit card type from `\MvcCore\Ext\Forms\Validators\CreditCard::$cardTypes`. Returns `MvcCore\Ext\Forms\Validators\CreditCard`
`public callable[] &`	# `GetExternalValidationCallbacks( )` Get list of external validation services defined as `callable`s. Defined functions could be indexed by priority index. Every `callable` item in array accepts first argument as raw user input string, second argument as `\MvcCore\Ext\forms\IField` instance and third argument configured allowed credit card types strings array (if empty array, all types allowed). `Callable` has to return safe user input value or `NULL` if value is not allowed. Get list of external validation services defined as `callable`s. Defined functions could be indexed by priority index. Every `callable` item in array accepts first argument as raw user input string, second argument as `\MvcCore\Ext\forms\IField` instance and third argument configured allowed credit card types strings array (if empty array, all types allowed). `Callable` has to return safe user input value or `NULL` if value is not allowed. Returns callable[]
`public MvcCore\Ext\Forms\Validators\CreditCard`	# `SetExternalValidationCallbacks( )` Set list of external validation services defined as `callable`s. Defined functions could be indexed by priority index. This function is dangerous, because it removes all previously defined external validation callbacks. If you only add another external validation callback, use: `$validator->AddExternalValidationCallback();` instead. Every `callable` item in array has to accept first argument as raw user input string, second argument as `\MvcCore\Ext\forms\IField` instance and third argument configured allowed credit card types strings array (if empty array, all types allowed). `Callable` has to return safe user input value or `NULL` if value is not allowed. Set list of external validation services defined as `callable`s. Defined functions could be indexed by priority index. This function is dangerous, because it removes all previously defined external validation callbacks. If you only add another external validation callback, use: `$validator->AddExternalValidationCallback();` instead. Every `callable` item in array has to accept first argument as raw user input string, second argument as `\MvcCore\Ext\forms\IField` instance and third argument configured allowed credit card types strings array (if empty array, all types allowed). `Callable` has to return safe user input value or `NULL` if value is not allowed. Returns `MvcCore\Ext\Forms\Validators\CreditCard`
`public MvcCore\Ext\Forms\Validators\CreditCard`	# `AddExternalValidationCallbacks( )` Add list of external validation services defined as `callable`s. Defined functions could be indexed by priority index. Every `callable` item in array has to accept first argument as raw user input string, second argument as `\MvcCore\Ext\forms\IField` instance and third argument configured allowed credit card types strings array (if empty array, all types allowed). `Callable` has to return safe user input value or `NULL` if value is not allowed. Add list of external validation services defined as `callable`s. Defined functions could be indexed by priority index. Every `callable` item in array has to accept first argument as raw user input string, second argument as `\MvcCore\Ext\forms\IField` instance and third argument configured allowed credit card types strings array (if empty array, all types allowed). `Callable` has to return safe user input value or `NULL` if value is not allowed. Returns `MvcCore\Ext\Forms\Validators\CreditCard`
`public MvcCore\Ext\Forms\Validators\CreditCard`	# `AddExternalValidationCallback( callable[] $externalValidationCallback, integer\|null $priorityIndex = NULL )` Add external validation service defined as `callable`. Defined function could be indexed by priority index. Given function has to accept first argument as raw user input string, second argument as `\MvcCore\Ext\forms\IField` instance and third argument configured allowed credit card types strings array (if empty array, all types allowed). `Callable` has to return safe user input value or `NULL` if value is not allowed. Add external validation service defined as `callable`. Defined function could be indexed by priority index. Given function has to accept first argument as raw user input string, second argument as `\MvcCore\Ext\forms\IField` instance and third argument configured allowed credit card types strings array (if empty array, all types allowed). `Callable` has to return safe user input value or `NULL` if value is not allowed. Parameters `$externalValidationCallback` `Callable accepting as first argument raw user input, second argument as`\MvcCore\Ext\forms\IField`instance and third argument configured allowed credit card types strings array (if empty array, all types allowed).`Callable`has to return safe user input value or`NULL` if value is not allowed. `$priorityIndex` Default value is `NULL`. Returns `MvcCore\Ext\Forms\Validators\CreditCard`
`public string\|null`	# `Validate( string\|array $rawSubmittedValue )` Returns valid credit card number as string if and only if `$rawSubmittedValue` follows the Luhn algorithm (mod-10 checksum). Returns valid credit card number as string if and only if `$rawSubmittedValue` follows the Luhn algorithm (mod-10 checksum). Parameters `$rawSubmittedValue` Raw submitted value from user. Returns string\|null Safe submitted value or `NULL` if not possible to return safe value.

Methods inherited from MvcCore\Ext\Forms\Validator
`CreateInstance(), GetErrorMessage(), SetField(), SetForm(), __construct(), setUpFieldProps(), throwNewInvalidArgumentException()`

Constants summary
`string`	`AMERICAN_EXPRESS` Detected CCI list. Detected CCI list.	# `'American_Express'`
`string`	`UNIONPAY`	# `'Unionpay'`
`string`	`DINERS_CLUB`	# `'Diners_Club'`
`string`	`DINERS_CLUB_US`	# `'Diners_Club_US'`
`string`	`DISCOVER`	# `'Discover'`
`string`	`JCB`	# `'JCB'`
`string`	`LASER`	# `'Laser'`
`string`	`MAESTRO`	# `'Maestro'`
`string`	`MASTERCARD`	# `'Mastercard'`
`string`	`SOLO`	# `'Solo'`
`string`	`VISA`	# `'Visa'`
`string`	`MIR`	# `'Mir'`
`integer`	`ERROR_CHECKSUM` Error message index(es). Error message index(es).	# `0`
`integer`	`ERROR_CONTENT`	# `1`
`integer`	`ERROR_INVALID`	# `2`
`integer`	`ERROR_LENGTH`	# `3`
`integer`	`ERROR_PREFIX`	# `4`
`integer`	`ERROR_SERVICE`	# `5`
`integer`	`ERROR_SERVICEFAILURE`	# `6`

Properties summary
`protected static array`	`$cardTypes` List of CCV names. List of CCV names.	# `[ self::AMERICAN_EXPRESS, self::DINERS_CLUB, self::DINERS_CLUB_US, self::DISCOVER, self::JCB, self::LASER, self::MAESTRO, self::MASTERCARD, self::SOLO, self::UNIONPAY, self::VISA, self::MIR, ]`
`protected static array`	`$cardLengths` List of allowed CCV lengths. List of allowed CCV lengths.	# `[ self::AMERICAN_EXPRESS => [15], self::DINERS_CLUB => [14], self::DINERS_CLUB_US => [16], self::DISCOVER => [16, 19], self::JCB => [15, 16], self::LASER => [16, 17, 18, 19], self::MAESTRO => [12, 13, 14, 15, 16, 17, 18, 19], self::MASTERCARD => [16], self::SOLO => [16, 18, 19], self::UNIONPAY => [16, 17, 18, 19], self::VISA => [13, 16, 19], self::MIR => [13, 16], ]`
`protected static array`	`$cardPrefixes` List of accepted CCV provider tags. List of accepted CCV provider tags.	# [ self::AMERICAN_EXPRESS => ['34', '37'], self::DINERS_CLUB => ['300', '301', '302', '303', '304', '305', '36'], self::DINERS_CLUB_US => ['54', '55'], self::DISCOVER => ['6011', '622126', '622127', '622128', '622129', '62213', '62214', '62215', '62216', '62217', '62218', '62219', '6222', '6223', '6224', '6225', '6226', '6227', '6228', '62290', '62291', '622920', '622921', '622922', '622923', '622924', '622925', '644', '645', '646', '647', '648', '649', '65'], self::JCB => ['1800', '2131', '3528', '3529', '353', '354', '355', '356', '357', '358'], self::LASER => ['6304', '6706', '6771', '6709'], self::MAESTRO => ['5018', '5020', '5038', '6304', '6759', '6761', '6762', '6763', '6764', '6765', '6766', '6772'], self::MASTERCARD => ['2221', '2222', '2223', '2224', '2225', '2226', '2227', '2228', '2229', '223', '224', '225', '226', '227', '228', '229', '23', '24', '25', '26', '271', '2720', '51', '52', '53', '54', '55'], self::SOLO => ['6334', '6767'], self::UNIONPAY => ['622126', '622127', '622128', '622129', '62213', '62214', '62215', '62216', '62217', '62218', '62219', '6222', '6223', '6224', '6225', '6226', '6227', '6228', '62290', '62291', '622920', '622921', '622922', '622923', '622924', '622925'], self::VISA => ['4'], self::MIR => ['2200', '2201', '2202', '2203', '2204'], ]
`protected static array`	`$errorMessages` Validation failure message template definitions. Validation failure message template definitions.	# `[ self::ERROR_CHECKSUM => "Field '{0}' contains an invalid checksum.", self::ERROR_CONTENT => "Field '{0}' must contain only digits.", self::ERROR_LENGTH => "Field '{0}' contains an invalid amount of digits.", self::ERROR_PREFIX => "Field '{0}' is not from an allowed institute.", self::ERROR_SERVICE => "Field '{0}' seems to be an invalid credit card number.", self::ERROR_SERVICEFAILURE => "Field '{0}' throws an exception while validating the input.", ]`
`protected string[]`	`$allowedTypes` Allowed credit card types. If no allowed credit card types defined, then all credit card types are allowed automatically. Array of string constants like: `\MvcCore\Ext\Forms\Validators\CreditCard::VISA ...`. Allowed credit card types. If no allowed credit card types defined, then all credit card types are allowed automatically. Array of string constants like: `\MvcCore\Ext\Forms\Validators\CreditCard::VISA ...`.	# `[]`
`protected callable[]`	`$externalValidationCallbacks` List of external validation services defined as `callable`s. Defined functions could be indexed by priority index. Every `callable` item in array has to accept first argument as raw user input string, second argument as `\MvcCore\Ext\forms\IField` instance and third argument configured allowed credit card types strings array (if empty array, all types allowed). `Callable` has to return safe user input value or `NULL` if value is not allowed. List of external validation services defined as `callable`s. Defined functions could be indexed by priority index. Every `callable` item in array has to accept first argument as raw user input string, second argument as `\MvcCore\Ext\forms\IField` instance and third argument configured allowed credit card types strings array (if empty array, all types allowed). `Callable` has to return safe user input value or `NULL` if value is not allowed.	# `[]`

Properties inherited from MvcCore\Ext\Forms\Validator
`$field, $fieldSpecificProperties, $form, $toolClass`

Classes

Interfaces

Traits

Exceptions

Functions

Class CreditCard

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns