Zend\I18n\Validator\PostCode
Synopsis
class PostCode
extends AbstractValidator
{
- // constants
- const INVALID = 'postcodeInvalid';
- const NO_MATCH = 'postcodeNoMatch';
- const SERVICE = 'postcodeService';
- const SERVICEFAILURE = 'postcodeServiceFailure';
- // members
- protected array $messageTemplates;
- protected string|null $locale;
- protected string|null $format;
- protected mixed|null $service;
- protected array $postCodeRegex;
- // Inherited members from AbstractValidator
- protected mixed $value;
- protected TranslatorInterface $defaultTranslator;
- protected string $defaultTranslatorTextDomain;
- protected integer $messageLength;
- protected array $abstractOptions;
- // methods
- public void __construct()
- public string|null getLocale()
- public PostCode setLocale()
- public string|null getFormat()
- public PostCode setFormat()
- public mixed|null getService()
- public PostCode setService()
- public bool isValid()
- // Inherited methods from AbstractValidator
- public void __construct()
- public mixed getOption()
- public array getOptions()
- public AbstractValidator setOptions()
- public array getMessages()
- public bool __invoke()
- public array getMessageVariables()
- public array getMessageTemplates()
- public AbstractValidator setMessage()
- public AbstractValidator setMessages()
- public mixed __get()
- protected string createMessage()
- protected void error()
- protected mixed getValue()
- protected void setValue()
- public AbstractValidator setValueObscured()
- public bool isValueObscured()
- public AbstractValidator setTranslator()
- public TranslatorInterface|null getTranslator()
- public bool hasTranslator()
- public AbstractValidator setTranslatorTextDomain()
- public string getTranslatorTextDomain()
- public static void setDefaultTranslator()
- public static TranslatorInterface|null getDefaultTranslator()
- public static bool hasDefaultTranslator()
- public static void setDefaultTranslatorTextDomain()
- public static string getDefaultTranslatorTextDomain()
- public AbstractValidator setTranslatorEnabled()
- public bool isTranslatorEnabled()
- public static int getMessageLength()
- public static void setMessageLength()
- protected string translateMessage()
Hierarchy
Extends
Constants
Name | Value |
---|---|
INVALID | 'postcodeInvalid' |
NO_MATCH | 'postcodeNoMatch' |
SERVICE | 'postcodeService' |
SERVICEFAILURE | 'postcodeServiceFailure' |
Members
protected
- $abstractOptions
- $defaultTranslator
—
Zend\Validator\Translator\TranslatorInterface
Default translation object for all validate objects - $defaultTranslatorTextDomain
—
string
Default text domain to be used with translator - $format
—
Zend\I18n\Validator\string|null
Optional Manual postal code format - $locale
—
Zend\I18n\Validator\string|null
Optional Locale to use - $messageLength
—
int
Limits the maximum returned length of an error message - $messageTemplates — array
- $postCodeRegex
—
array
Postal Code regexes by territory - $service
—
Zend\I18n\Validator\mixed|null
Optional Service callback for additional validation - $value
—
mixed
The value to be validated
Methods
public
- __construct() — Constructor for the PostCode validator
- getFormat() — Returns the set postal code format
- getLocale() — Returns the set locale
- getService() — Returns the actual set service
- isValid() — Returns true if and only if $value is a valid postalcode
- setFormat() — Sets a self defined postal format as regex
- setLocale() — Sets the locale to use
- setService() — Sets a new callback for service validation
Inherited from Zend\Validator\AbstractValidator
protected
- createMessage() — Constructs and returns a validation failure message with the given message key and value.
- error()
- getValue() — Returns the validation value
- setValue() — Sets the value to be validated and clears the messages and errors arrays
- translateMessage() — Translate a validation message
public
- __get() — Magic function returns the value of the requested property, if and only if it is the value or a message variable.
- __invoke() — Invoke as command
- getDefaultTranslator() — Get default translation object for all validate objects
- getDefaultTranslatorTextDomain() — Get default translation text domain for all validate objects
- getMessageLength() — Returns the maximum allowed message length
- getMessageTemplates() — Returns the message templates from the validator
- getMessageVariables() — Returns an array of the names of variables that are used in constructing validation failure messages
- getMessages() — Returns array of validation failure messages
- getOption() — Returns an option
- getOptions() — Returns all available options
- getTranslator() — Return translation object
- getTranslatorTextDomain() — Return the translation text domain
- hasDefaultTranslator() — Is there a default translation object set?
- hasTranslator() — Does this validator have its own specific translator?
- isTranslatorEnabled() — Is translation enabled?
- isValueObscured() — Retrieve flag indicating whether or not value should be obfuscated in messages
- setDefaultTranslator() — Set default translation object for all validate objects
- setDefaultTranslatorTextDomain() — Set default translation text domain for all validate objects
- setMessage() — Sets the validation failure message template for a particular key
- setMessageLength() — Sets the maximum allowed message length
- 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.
- setOptions() — Sets one or multiple options
- setTranslator() — Set translation object
- setTranslatorEnabled() — Indicate whether or not translation should be enabled
- setTranslatorTextDomain() — Set translation text domain
- setValueObscured() — Set flag indicating whether or not value should be obfuscated in messages