Class ZipCode

Responsibility: Validate ZIP code by specific locale rules.

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

MvcCore\Ext\Forms\Validators\ZipCode

Namespace: MvcCore\Ext\Forms\Validators
See: https://github.com/zendframework/zend-i18n
See: https://github.com/zendframework/zend-i18n/blob/master/src/Validator/PostCode.php
Located at ext-form-validator-special/src/MvcCore/Ext/Forms/Validators/ZipCode.php

Methods summary
`public static string\|callable`	# `SetValidator( string $localeCode, string\|callable $regExpMatchOrCallable )` Set specific locale validator for ZIP code. It could be `regexp match pattern string` without border characters (`#^$/`) or `callable` accepting first argument to be raw submitted value and returning array with success and with safe ZIP code value. Set specific locale validator for ZIP code. It could be `regexp match pattern string` without border characters (`#^$/`) or `callable` accepting first argument to be raw submitted value and returning array with success and with safe ZIP code value. Parameters `$localeCode` Locale code, automatically converted to upper case. `$regExpMatchOrCallable` `Regexp match pattern string` without border characters (`#^$/`) or `callable`. Returns string\|callable
`public static array &`	# `GetValidators( )` Get all preconfigured validators as key/value array. Keys are locale codes and values are `regexp match pattern string`s or `callable`s. Get all preconfigured validators as key/value array. Keys are locale codes and values are `regexp match pattern string`s or `callable`s. Returns array
`public string\|null`	# `Validate( string\|array $rawSubmittedValue )` Validate ZIP code by form internal localization property `$form->GetLocale()`. Validate ZIP code by form internal localization property `$form->GetLocale()`. Parameters `$rawSubmittedValue` Raw submitted value from user. Returns string\|null Safe submitted value or `NULL` if not possible to return safe value.
`protected array`	# `validateZipByRegExp( string $zip, string $regExpMatch, string $localeCode )` Validate ZIP code by regular expression match pattern. Return if matches and safe ZIP code value. Validate ZIP code by regular expression match pattern. Return if matches and safe ZIP code value. Parameters `$zip` Raw submitted value. `$regExpMatch` Regep match pattern without border characters (`#^$/`). `$localeCode` Form locale upper case code. Returns array Array with success and safe ZIP code value.

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

Constants summary
`integer`	`ERROR_NOT_SUPPORTED` Error message index(es). Error message index(es).	# `0`
`integer`	`ERROR_VALIDATOR_WRONG_FORMAT`	# `1`
`integer`	`ERROR_WRONG_PATTERN`	# `2`
`integer`	`ERROR_INVALID_ZIP`	# `3`

Properties summary
`protected static array`	`$errorMessages` Validation failure message template definitions. Validation failure message template definitions.	# [ self::ERROR_NOT_SUPPORTED => "Field '{0}' has not supported validation for ZIP code in locale: `{1}`.", self::ERROR_VALIDATOR_WRONG_FORMAT => "Field '{0}' has ZIP code validator in locale `{1}` in wrong format.", self::ERROR_WRONG_PATTERN => "Field '{0}' has wrong ZIP code validation pattern: `{1}`.", self::ERROR_INVALID_ZIP => "Field '{0}' requires a valid zip code.", ]
`protected static array`	`$validators` All configured validators as key/value array. Keys are locale codes and values are regular expression match pattern strings or `callable`s. All configured validators as key/value array. Keys are locale codes and values are regular expression match pattern strings or `callable`s.	# `[]`

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

Classes

Interfaces

Traits

Exceptions

Functions

Class ZipCode

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns