Zend Framework  3.0
Public Member Functions | Public Attributes | Protected Attributes | List of all members
CreditCard Class Reference

Public Member Functions

 __construct ($options=[])
 Constructor.
 
 getType ()
 Returns a list of accepted CCIs.
 
 setType ($type)
 Sets CCIs which are accepted by validation.
 
 addType ($type)
 Adds a CCI to be accepted by validation.
 
 getService ()
 Returns the actual set service.
 
 setService ($service)
 Sets a new callback for service validation.
 
 isValid ($value)
 Returns true if and only if $value follows the Luhn algorithm (mod-10 checksum)
 
- 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=[])
 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 ALL = 'All'
 
const AMERICAN_EXPRESS = 'American_Express'
 
const UNIONPAY = 'Unionpay'
 
const DINERS_CLUB = 'Diners_Club'
 
const DINERS_CLUB_US = 'Diners_Club_US'
 
const DISCOVER = 'Discover'
 
const JCB = 'JCB'
 
const LASER = 'Laser'
 
const MAESTRO = 'Maestro'
 
const MASTERCARD = 'Mastercard'
 
const SOLO = 'Solo'
 
const VISA = 'Visa'
 
const CHECKSUM = 'creditcardChecksum'
 
const CONTENT = 'creditcardContent'
 
const INVALID = 'creditcardInvalid'
 
const LENGTH = 'creditcardLength'
 
const PREFIX = 'creditcardPrefix'
 
const SERVICE = 'creditcardService'
 
const SERVICEFAILURE = 'creditcardServiceFailure'
 

Protected Attributes

 $messageTemplates
 
 $cardName
 
 $cardLength
 
 $cardType
 
 $options
 
- Protected Attributes inherited from AbstractValidator
 $value
 
 $abstractOptions
 

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.
 
- Static Protected Attributes inherited from AbstractValidator
static $defaultTranslator
 
static $defaultTranslatorTextDomain = 'default'
 
static $messageLength = -1
 

Constructor & Destructor Documentation

__construct (   $options = [])

Constructor.

Parameters
string | array | Traversable$optionsOPTIONAL Type of CCI to allow

Member Function Documentation

addType (   $type)

Adds a CCI to be accepted by validation.

Parameters
string | array$typeType to allow for validation
Returns
CreditCard Provides a fluid interface
getService ( )

Returns the actual set service.

Returns
callable
getType ( )

Returns a list of accepted CCIs.

Returns
array
isValid (   $value)

Returns true if and only if $value follows the Luhn algorithm (mod-10 checksum)

Parameters
string$value
Returns
bool

Implements ValidatorInterface.

setService (   $service)

Sets a new callback for service validation.

Parameters
callable$service
Returns
CreditCard
Exceptions
Exception\InvalidArgumentExceptionon invalid service callback
setType (   $type)

Sets CCIs which are accepted by validation.

Parameters
string | array$typeType to allow for validation
Returns
CreditCard Provides a fluid interface

Member Data Documentation

$cardLength
protected
Initial value:
= [
self::AMERICAN_EXPRESS => [15]
$cardName
protected
Initial value:
= [
0 => self::AMERICAN_EXPRESS
$cardType
protected
Initial value:
= [
self::AMERICAN_EXPRESS => ['34', '37']
$messageTemplates
protected
Initial value:
= [
self::CHECKSUM => "The input seems to contain an invalid checksum"
$options
protected
Initial value:
= [
'service' => null
const ALL = 'All'
const AMERICAN_EXPRESS = 'American_Express'
const CHECKSUM = 'creditcardChecksum'
const CONTENT = 'creditcardContent'
const DINERS_CLUB = 'Diners_Club'
const DINERS_CLUB_US = 'Diners_Club_US'
const DISCOVER = 'Discover'
const INVALID = 'creditcardInvalid'
const JCB = 'JCB'
const LASER = 'Laser'
const LENGTH = 'creditcardLength'
const MAESTRO = 'Maestro'
const MASTERCARD = 'Mastercard'
const PREFIX = 'creditcardPrefix'
const SERVICE = 'creditcardService'
const SERVICEFAILURE = 'creditcardServiceFailure'
const SOLO = 'Solo'
const UNIONPAY = 'Unionpay'
const VISA = 'Visa'