Validate/PostCode.php

Show: PublicProtectedPrivateinherited
Table of Contents
Zend Framework
LICENSE This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Validate  
Version
$Id$  

\Zend_Validate_PostCode

Package: Zend_Validate
Parent(s)
\Zend_Validate_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

>VConstant  INVALID = 'postcodeInvalid'
>VConstant  NO_MATCH = 'postcodeNoMatch'

Properties

>VPropertyprotected\unknown_type $_format
Manual postal code format
Details
Type
\unknown_type
>VPropertyprotectedstring $_locale
Locale to use
Details
Type
string
>VPropertyprotectedarray $_messageTemplates = array(self::INVALID => "Invalid type given. String or integer expected", self::NO_MATCH => "'%value%' does not appear to be a postal code")
Default valuearray(self::INVALID => "Invalid type given. String or integer expected", self::NO_MATCH => "'%value%' does not appear to be a postal code")Details
Type
array

Methods

methodpublic__construct(string | \Zend_Locale | array | \Zend_Config $options = null) : void

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
NameTypeDescription
$optionsstring | \Zend_Locale | array | \Zend_Config
Throws
ExceptionDescription
\Zend_Validate_ExceptionOn empty format
methodpublicgetFormat() : string

Returns the set postal code format

Returns
TypeDescription
string
methodpublicgetLocale() : string | \Zend_Locale

Returns the set locale

Returns
TypeDescription
string | \Zend_LocaleThe set locale
methodpublicisValid(string $value) : boolean

Defined by Zend_Validate_Interface

Returns true if and only if $value is a valid postalcode
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
boolean
methodpublicsetFormat(string $format) : \Zend_Validate_PostCode

Sets a self defined postal format as regex

Parameters
NameTypeDescription
$formatstring
Returns
TypeDescription
\Zend_Validate_PostCodeProvides fluid interface
Throws
ExceptionDescription
\Zend_Validate_ExceptionOn empty format
methodpublicsetLocale(string | \Zend_Locale $locale = null) : \Zend_Validate_PostCode

Sets the locale to use

Parameters
NameTypeDescription
$localestring | \Zend_Locale
Returns
TypeDescription
\Zend_Validate_PostCodeProvides fluid interface
Throws
ExceptionDescription
\Zend_Validate_ExceptionOn unrecognised region
\Zend_Validate_ExceptionOn not detected format
Documentation was generated by phpDocumentor 2.2.0 .