Zend_Validate_PostCode Class Reference

Public Member Functions
	__construct ($options=null)
	Constructor for the integer validator.
	getLocale ()
	Returns the set locale.
	setLocale ($locale=null)
	Sets the locale to use.
	getFormat ()
	Returns the set postal code format.
	setFormat ($format)
	Sets a self defined postal format as regex.
	isValid ($value)
	Defined by Zend_Validate_Interface.
Public Member Functions inherited from Zend_Validate_Abstract
	getMessages ()
	Returns array of validation failure messages.
	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.
	getErrors ()
	Returns array of validation failure message codes.
	setObscureValue ($flag)
	Set flag indicating whether or not value should be obfuscated in messages.
	getObscureValue ()
	Retrieve flag indicating whether or not value should be obfuscated in messages.
	setTranslator ($translator=null)
	Set translation object.
	getTranslator ()
	Return translation object.
	hasTranslator ()
	Does this validator have its own specific translator?
	setDisableTranslator ($flag)
	Indicate whether or not translation should be disabled.
	translatorIsDisabled ()
	Is translation disabled?

Public Attributes
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)
	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	getMessageLength ()
	Returns the maximum allowed message length.
static	setMessageLength ($length=-1)
	Sets the maximum allowed message length.
Protected Member Functions inherited from Zend_Validate_Abstract
	_createMessage ($messageKey, $value)
	Constructs and returns a validation failure message with the given message key and value.
	_error ($messageKey, $value=null)
	_setValue ($value)
	Sets the value to be validated and clears the messages and errors arrays.
Static Protected Attributes inherited from Zend_Validate_Abstract
static	$_defaultTranslator
static	$_messageLength = -1

Constructor & Destructor Documentation

__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

Member Function Documentation

getFormat

(

)

Returns the set postal code format.

Returns

string

getLocale

(

)

Returns the set locale.

Returns

string|Zend_Locale The set locale

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.

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 fluid interface

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 fluid interface

Member Data Documentation

$_format

protected

$_locale

protected

$_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",
    )

const INVALID = 'postcodeInvalid'

const NO_MATCH = 'postcodeNoMatch'