Fully Qualified Name: | Zend\I18n\Validator\PostCode |
Extends: | AbstractValidator |
Name | Description | Defined By |
---|---|---|
__construct() | Constructor for the PostCode validator | PostCode |
__get() | Magic function returns the value of the requested property, if and only if it is the value or a message variable. | AbstractValidator |
__invoke() | Invoke as command | AbstractValidator |
getDefaultTranslator() | Get default translation object for all validate objects | AbstractValidator |
getDefaultTranslatorTextDomain() | Get default translation text domain for all validate objects | AbstractValidator |
getFormat() | Returns the set postal code format | PostCode |
getLocale() | Returns the set locale | PostCode |
getMessageLength() | Returns the maximum allowed message length | AbstractValidator |
getMessageTemplates() | Returns the message templates from the validator | AbstractValidator |
getMessageVariables() | Returns an array of the names of variables that are used in constructing validation failure messages | AbstractValidator |
getMessages() | Returns array of validation failure messages | AbstractValidator |
getOption() | Returns an option | AbstractValidator |
getOptions() | Returns all available options | AbstractValidator |
getService() | Returns the actual set service | PostCode |
getTranslator() | Return translation object | AbstractValidator |
getTranslatorTextDomain() | Return the translation text domain | AbstractValidator |
hasDefaultTranslator() | Is there a default translation object set? | AbstractValidator |
hasTranslator() | Does this validator have its own specific translator? | AbstractValidator |
isTranslatorEnabled() | Is translation enabled? | AbstractValidator |
isValid() | Returns true if and only if $value is a valid postalcode | PostCode |
isValueObscured() | Retrieve flag indicating whether or not value should be obfuscated in messages | AbstractValidator |
setDefaultTranslator() | Set default translation object for all validate objects | AbstractValidator |
setDefaultTranslatorTextDomain() | Set default translation text domain for all validate objects | AbstractValidator |
setFormat() | Sets a self defined postal format as regex | PostCode |
setLocale() | Sets the locale to use | PostCode |
setMessage() | Sets the validation failure message template for a particular key | AbstractValidator |
setMessageLength() | Sets the maximum allowed message length | AbstractValidator |
setMessages() | 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. | AbstractValidator |
setOptions() | Sets one or multiple options | AbstractValidator |
setService() | Sets a new callback for service validation | PostCode |
setTranslator() | Set translation object | AbstractValidator |
setTranslatorEnabled() | Indicate whether or not translation should be enabled | AbstractValidator |
setTranslatorTextDomain() | Set translation text domain | AbstractValidator |
setValueObscured() | Set flag indicating whether or not value should be obfuscated in messages | AbstractValidator |
Constructor for the PostCode validator
Accepts a string locale and/or "format".
Parameter Name | Type | Description |
---|---|---|
$options | array|\Traversable |
Returns:
Magic function returns the value of the requested property, if and only if it is the value or a message variable.
Parameter Name | Type | Description |
---|---|---|
$property | string |
Returns: mixed
Invoke as command
Parameter Name | Type | Description |
---|---|---|
$value | mixed |
Returns: bool
Get default translation object for all validate objects
Returns: \Translator\TranslatorInterface|null
Get default translation text domain for all validate objects
Returns: string
Returns the set postal code format
Returns: string|null
Returns the set locale
Returns: string|null The set locale
Returns the maximum allowed message length
Returns: int
Returns the message templates from the validator
Returns: array
Returns an array of the names of variables that are used in constructing validation failure messages
Returns: array
Returns array of validation failure messages
Returns: array
Returns an option
Parameter Name | Type | Description |
---|---|---|
$option | string | Option |
Returns: mixed Returned option
Returns all available options
Returns: array Array with all available options
Returns the actual set service
Returns: mixed|null
Return translation object
Returns: \Translator\TranslatorInterface|null
Return the translation text domain
Returns: string
Is there a default translation object set?
Returns: bool
Does this validator have its own specific translator?
Returns: bool
Is translation enabled?
Returns: bool
Returns true if and only if $value is a valid postalcode
Parameter Name | Type | Description |
---|---|---|
$value | string |
Returns: bool
Retrieve flag indicating whether or not value should be obfuscated in messages
Returns: bool
Set default translation object for all validate objects
Parameter Name | Type | Description |
---|---|---|
$translator | \Translator\TranslatorInterface|null | |
$textDomain | string | (optional) |
Returns: void
Set default translation text domain for all validate objects
Parameter Name | Type | Description |
---|---|---|
$textDomain | string |
Returns: void
Sets a self defined postal format as regex
Parameter Name | Type | Description |
---|---|---|
$format | string |
Returns: \PostCode Provides fluid interface
Sets the locale to use
Parameter Name | Type | Description |
---|---|---|
$locale | string|null |
Returns: \PostCode Provides fluid interface
Sets the validation failure message template for a particular key
Parameter Name | Type | Description |
---|---|---|
$messageString | string | |
$messageKey | string | OPTIONAL |
Returns: \AbstractValidator Provides a fluent interface
Sets the maximum allowed message length
Parameter Name | Type | Description |
---|---|---|
$length | int |
Returns:
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.
Parameter Name | Type | Description |
---|---|---|
$messages | array |
Returns: \AbstractValidator
Sets one or multiple options
Parameter Name | Type | Description |
---|---|---|
$options | array|\Traversable | Options |
Returns: \AbstractValidator Provides fluid interface
Sets a new callback for service validation
Parameter Name | Type | Description |
---|---|---|
$service | mixed |
Returns: \PostCode Provides fluid interface
Set translation object
Parameter Name | Type | Description |
---|---|---|
$translator | \Translator\TranslatorInterface|null | |
$textDomain | string | (optional) |
Returns: \AbstractValidator
Indicate whether or not translation should be enabled
Parameter Name | Type | Description |
---|---|---|
$flag | bool |
Returns: \AbstractValidator
Set translation text domain
Parameter Name | Type | Description |
---|---|---|
$textDomain | string |
Returns: \AbstractValidator
Set flag indicating whether or not value should be obfuscated in messages
Parameter Name | Type | Description |
---|---|---|
$flag | bool |
Returns: \AbstractValidator