API Documentation

Zend/Validate/PostCode.php

Show: inherited
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 license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Validate  
Version
$Id: PostCode.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Validate_PostCode

Package: Zend\Validate

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

Constants

Constant  INVALID = 'postcodeInvalid'
Constant  NO_MATCH = 'postcodeNoMatch'

Properties

Propertyprotected\unknown_type  $_format= ''

Manual postal code format

Details
Type
\unknown_type
Propertyprotectedstring  $_locale= ''

Locale to use

Details
Type
string
Propertyprotectedarray  $_messageTemplates= 'array( self::INVALID => "Invalid type given. String or integer expected"'

Default valuearray( self::INVALID => "Invalid type given. String or integer expected"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
Name Type Description
$options string|\Zend_Locale|array|\Zend_Config
Throws
Exception Description
\Zend_Validate_Exception On empty format
methodpublicgetFormat( ) : string

Returns the set postal code format

Returns
Type Description
string
methodpublicgetLocale( ) : string|\Zend_Locale

Returns the set locale

Returns
Type Description
string|\Zend_Locale The set locale
methodpublicisValid( string $value ) : boolean

Defined by Zend_Validate_Interface

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

Parameters
Name Type Description
$value string
Returns
Type Description
boolean
methodpublicsetFormat( string $format ) : \Zend_Validate_PostCode

Sets a self defined postal format as regex

Parameters
Name Type Description
$format string
Returns
Type Description
\Zend_Validate_PostCode Provides fluid interface
Throws
Exception Description
\Zend_Validate_Exception On empty format
methodpublicsetLocale( string|\Zend_Locale $locale = null ) : \Zend_Validate_PostCode

Sets the locale to use

Parameters
Name Type Description
$locale string|\Zend_Locale
Returns
Type Description
\Zend_Validate_PostCode Provides fluid interface
Throws
Exception Description
\Zend_Validate_Exception On unrecognised region
\Zend_Validate_Exception On not detected format
Documentation was generated by DocBlox 0.15.1.