Zend Framework: Zend_Validate_PostCode Component Proposal

Proposed Component Name	Zend_Validate_PostCode
Developer Notes	http://framework.zend.com/wiki/display/ZFDEV/Zend_Validate_PostCode
Proposers	Thomas Weidner
Zend Liaison	TBD
Revision	1.0 - 7 June 2009: Initial Draft. (wiki revision: 8)

This component uses Zend_Locale to get the postal code informations for all known countries. These are then used to detect if the given input is a postal code or not. This component can not detect if a given postal code exists or not. It only checks if a given input can be a postal code, if the notation conforms, or not.

6. Milestones / Tasks

Milestone 1: [DONE] Proposal finished
Milestone 2: [DONE] Proposal accepted
Milestone 3: [DONE] Coding finished
Milestone 4: [DONE] Unit tests finished
Milestone 5: [DONE] Documentation finished
Milestone 6: [DONE] Component moved to core

7. Class Index

Zend_Validate_PostCode

8. Use Cases

UC-01

Uses set application wide locale to detect the region to use

$validator = new Zend_Validate_PostCode();
$validator->isValid('AT-1234');

UC-02

Sets a region where the postal code is related to

$validator = new Zend_Validate_PostCode(array('locale' => 'de_AT'));
$validator->isValid('AT-1234');

or set it afterwards

$validator = new Zend_Validate_PostCode();
$validator->setLocale('de_AT');
$validator->isValid('AT-1234');

UC-03

Sets a self defined format for postal code validation

$validator = new Zend_Validate_PostCode(array('format' => '/^[0-9]{5-7}'));
$validator->isValid('12345');

9. Class Skeletons

class Zend_Validate_PostCode {
    public function __construct($options);
    public function getLocale();
    public function setLocale();
    public function getFormat();
    public function setFormat();
    public function isValid($input);
}

Page Operations

Browse Space

Zend_Validate_PostCode - Thomas Weidner

Labels

Zend Framework: Zend_Validate_PostCode Component Proposal

Table of Contents

1. Overview

2. References

3. Component Requirements, Constraints, and Acceptance Criteria

4. Dependencies on Other Framework Components

5. Theory of Operation

6. Milestones / Tasks

7. Class Index

8. Use Cases

9. Class Skeletons