Zend_Validate_PostCode Class Reference

Inheritance diagram for Zend_Validate_PostCode:

Public Member Functions
	__construct ($options=null)
	getLocale ()
	setLocale ($locale=null)
	getFormat ()
	setFormat ($format)
	isValid ($value)
Public Member Functions inherited from Zend_Validate_Abstract
	getMessages ()
	getMessageVariables ()
	getMessageTemplates ()
	setMessage ($messageString, $messageKey=null)
	setMessages (array $messages)
	__get ($property)
	getErrors ()
	setObscureValue ($flag)
	getObscureValue ()
	setTranslator ($translator=null)
	getTranslator ()
	hasTranslator ()
	setDisableTranslator ($flag)
	translatorIsDisabled ()

Data Fields
const	INVALID = 'postcodeInvalid'
const	NO_MATCH = 'postcodeNoMatch'

Protected Attributes
	$_messageTemplates
	$_locale
	$_format
Protected Attributes inherited from Zend_Validate_Abstract
	$_value
	$_messageVariables = array()
	$_messageTemplates = array()
	$_messages = array()
	$_obscureValue = false
	$_errors = array()
	$_translator
	$_translatorDisabled = false

Additional Inherited Members
Static Public Member Functions inherited from Zend_Validate_Abstract
static	setDefaultTranslator ($translator=null)
static	getDefaultTranslator ()
static	hasDefaultTranslator ()
static	getMessageLength ()
static	setMessageLength ($length=-1)
Protected Member Functions inherited from Zend_Validate_Abstract
	_createMessage ($messageKey, $value)
	_implodeRecursive (array $pieces)
	_error ($messageKey, $value=null)
	_setValue ($value)
Static Protected Attributes inherited from Zend_Validate_Abstract
static	$_defaultTranslator
static	$_messageLength = -1

Detailed Description

Definition at line 38 of file PostCode.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = null

)

Constructor for the integer validator

Accepts either a string locale, a Zend_Locale object, or an array or Zend_Config object containing the keys "locale" and/or "format".

Parameters

string | Zend_Locale | array | Zend_Config

$options

Exceptions

Zend_Validate_Exception

On empty format

Definition at line 74 of file PostCode.php.

    {
        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        }

        if (empty($options)) {
            #require_once 'Zend/Registry.php';
            if (Zend_Registry::isRegistered('Zend_Locale')) {
                $this->setLocale(Zend_Registry::get('Zend_Locale'));
            }
        } elseif (is_array($options)) {
            // Received
            if (array_key_exists('locale', $options)) {
                $this->setLocale($options['locale']);
            }

            if (array_key_exists('format', $options)) {
                $this->setFormat($options['format']);
            }
        } elseif ($options instanceof Zend_Locale || is_string($options)) {
            // Received Locale object or string locale
            $this->setLocale($options);
        }

        $format = $this->getFormat();
        if (empty($format)) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception("A postcode-format string has to be given for validation");
        }
    }

Member Function Documentation

getFormat()

getFormat

(

)

Returns the set postal code format

Returns

string

Definition at line 155 of file PostCode.php.

    {
        return $this->_format;
    }

getLocale()

getLocale

(

)

Returns the set locale

Returns

string|Zend_Locale The set locale

Definition at line 111 of file PostCode.php.

    {
        return $this->_locale;
    }

isValid()

isValid

(

$value

)

Defined by Zend_Validate_Interface

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

Parameters

string

$value

Returns

boolean

Implements Zend_Validate_Interface.

Definition at line 194 of file PostCode.php.

    {
        $this->_setValue($value);
        if (!is_string($value) && !is_int($value)) {
            $this->_error(self::INVALID);
            return false;
        }

        $format = $this->getFormat();
        if (!preg_match($format, $value)) {
            $this->_error(self::NO_MATCH);
            return false;
        }

        return true;
    }

setFormat()

setFormat

(

$format

)

Sets a self defined postal format as regex

Parameters

string

$format

Exceptions

Zend_Validate_Exception

On empty format

Returns

Zend_Validate_PostCode Provides a fluent interface

Definition at line 167 of file PostCode.php.

    {
        if (empty($format) || !is_string($format)) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception("A postcode-format string has to be given for validation");
        }

        if ($format[0] !== '/') {
            $format = '/^' . $format;
        }

        if ($format[strlen($format) - 1] !== '/') {
            $format .= '$/';
        }

        $this->_format = $format;
        return $this;
    }

setLocale()

setLocale

(

$locale = null

)

Sets the locale to use

Parameters

string | Zend_Locale

$locale

Exceptions

Zend_Validate_Exception	On unrecognised region
Zend_Validate_Exception	On not detected format

Returns

Zend_Validate_PostCode Provides a fluent interface

Definition at line 124 of file PostCode.php.

    {
        #require_once 'Zend/Locale.php';
        $this->_locale = Zend_Locale::findLocale($locale);
        $locale        = new Zend_Locale($this->_locale);
        $region        = $locale->getRegion();
        if (empty($region)) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception("Unable to detect a region for the locale '$locale'");
        }

        $format = Zend_Locale::getTranslation(
            $locale->getRegion(),
            'postaltoterritory',
            $this->_locale
        );

        if (empty($format)) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception("Unable to detect a postcode format for the region '{$locale->getRegion()}'");
        }

        $this->setFormat($format);
        return $this;
    }

Field Documentation

$_format

$_format

protected

Definition at line 63 of file PostCode.php.

$_locale

$_locale

protected

Definition at line 56 of file PostCode.php.

$_messageTemplates

$_messageTemplates

protected

Initial value:

= array(
        self::INVALID  => "Invalid type given. String or integer expected",
        self::NO_MATCH => "'%value%' does not appear to be a postal code",
    )

Definition at line 46 of file PostCode.php.

INVALID

const INVALID = 'postcodeInvalid'

Definition at line 40 of file PostCode.php.

NO_MATCH

const NO_MATCH = 'postcodeNoMatch'

Definition at line 41 of file PostCode.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Validate/PostCode.php