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

Public Member Functions

static __construct ($options=[])
 Constructor for the PostCode validator.
 
 getLocale ()
 Returns the set locale.
 
 setLocale ($locale)
 Sets the locale to use.
 
 getFormat ()
 Returns the set postal code format.
 
 setFormat ($format)
 Sets a self defined postal format as regex.
 
 getService ()
 Returns the actual set service.
 
 setService ($service)
 Sets a new callback for service validation.
 
 isValid ($value)
 Returns true if and only if $value is a valid postalcode.
 
- 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 INVALID = 'postcodeInvalid'
 
const NO_MATCH = 'postcodeNoMatch'
 
const SERVICE = 'postcodeService'
 
const SERVICEFAILURE = 'postcodeServiceFailure'
 

Protected Attributes

 $messageTemplates
 
 $locale
 
 $format
 
 $service
 
- Protected Attributes inherited from AbstractValidator
 $value
 
 $abstractOptions
 

Static Protected Attributes

static $postCodeRegex
 
- 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.
 

Constructor & Destructor Documentation

static __construct (   $options = [])

Constructor for the PostCode validator.

Accepts a string locale and/or "format".

Parameters
array | Traversable$options
Exceptions
Exception\ExtensionNotLoadedExceptionif ext/intl is not present

Member Function Documentation

getFormat ( )

Returns the set postal code format.

Returns
string|null
getLocale ( )

Returns the set locale.

Returns
string|null The set locale
getService ( )

Returns the actual set service.

Returns
mixed|null
isValid (   $value)

Returns true if and only if $value is a valid postalcode.

Parameters
string$value
Returns
bool
Exceptions
Exception\InvalidArgumentException

Implements ValidatorInterface.

setFormat (   $format)

Sets a self defined postal format as regex.

Parameters
string$format
Returns
PostCode Provides fluid interface
setLocale (   $locale)

Sets the locale to use.

Parameters
string | null$locale
Returns
PostCode Provides fluid interface
setService (   $service)

Sets a new callback for service validation.

Parameters
mixed$service
Returns
PostCode Provides fluid interface

Member Data Documentation

$format
protected
$locale
protected
$messageTemplates
protected
Initial value:
= [
self::INVALID => "Invalid type given. String or integer expected"
$postCodeRegex
staticprotected
Initial value:
= [
'GB' => 'GIR[ ]?0AA|^((AB|AL|B|BA|BB|BD|BH|BL|BN|BR|BS|BT|CA|CB|CF|CH|CM|CO|CR|CT|CV|CW|DA|DD|DE|DG|DH|DL|DN|DT|DY|E|EC|EH|EN|EX|FK|FY|G|GL|GY|GU|HA|HD|HG|HP|HR|HS|HU|HX|IG|IM|IP|IV|JE|KA|KT|KW|KY|L|LA|LD|LE|LL|LN|LS|LU|M|ME|MK|ML|N|NE|NG|NN|NP|NR|NW|OL|OX|PA|PE|PH|PL|PO|PR|RG|RH|RM|S|SA|SE|SG|SK|SL|SM|SN|SO|SP|SR|SS|ST|SW|SY|TA|TD|TF|TN|TQ|TR|TS|TW|UB|W|WA|WC|WD|WF|WN|WR|WS|WV|YO|ZE)(\d[\dA-Z]?[ ]?\d[ABD-HJLN-UW-Z]{2}))$|^BFPO[ ]?\d{1,4}'
$service
protected
const INVALID = 'postcodeInvalid'
const NO_MATCH = 'postcodeNoMatch'
const SERVICE = 'postcodeService'
const SERVICEFAILURE = 'postcodeServiceFailure'