blob: a84f02ea03f18cc4f12bcc13edecf786c255434f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
<?php
/**
* 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
* @package Postman_Zend_Validate
* @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @version $Id$
*/
/**
* @see Postman_Zend_Validate_Abstract
*/
require_once 'Zend/Validate/Abstract.php';
/**
* @see Postman_Zend_Locale_Format
*/
require_once 'Zend/Locale/Format.php';
/**
* @category Zend
* @package Postman_Zend_Validate
* @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
class Postman_Zend_Validate_PostCode extends Postman_Zend_Validate_Abstract
{
const INVALID = 'postcodeInvalid';
const NO_MATCH = 'postcodeNoMatch';
/**
* @var array
*/
protected $_messageTemplates = array(
self::INVALID => "Invalid type given. String or integer expected",
self::NO_MATCH => "'%value%' does not appear to be a postal code",
);
/**
* Locale to use
*
* @var string
*/
protected $_locale;
/**
* Manual postal code format
*
* @var unknown_type
*/
protected $_format;
/**
* Constructor for the integer validator
*
* Accepts either a string locale, a Postman_Zend_Locale object, or an array or
* Postman_Zend_Config object containing the keys "locale" and/or "format".
*
* @param string|Postman_Zend_Locale|array|Postman_Zend_Config $options
* @throws Postman_Zend_Validate_Exception On empty format
*/
public function __construct($options = null)
{
if ($options instanceof Postman_Zend_Config) {
$options = $options->toArray();
}
if (empty($options)) {
require_once 'Zend/Registry.php';
if (Postman_Zend_Registry::isRegistered('Postman_Zend_Locale')) {
$this->setLocale(Postman_Zend_Registry::get('Postman_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 Postman_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 Postman_Zend_Validate_Exception("A postcode-format string has to be given for validation");
}
}
/**
* Returns the set locale
*
* @return string|Postman_Zend_Locale The set locale
*/
public function getLocale()
{
return $this->_locale;
}
/**
* Sets the locale to use
*
* @param string|Postman_Zend_Locale $locale
* @throws Postman_Zend_Validate_Exception On unrecognised region
* @throws Postman_Zend_Validate_Exception On not detected format
* @return Postman_Zend_Validate_PostCode Provides a fluent interface
*/
public function setLocale($locale = null)
{
require_once 'Zend/Locale.php';
$this->_locale = Postman_Zend_Locale::findLocale($locale);
$locale = new Postman_Zend_Locale($this->_locale);
$region = $locale->getRegion();
if (empty($region)) {
require_once 'Zend/Validate/Exception.php';
throw new Postman_Zend_Validate_Exception("Unable to detect a region for the locale '$locale'");
}
$format = Postman_Zend_Locale::getTranslation(
$locale->getRegion(),
'postaltoterritory',
$this->_locale
);
if (empty($format)) {
require_once 'Zend/Validate/Exception.php';
throw new Postman_Zend_Validate_Exception("Unable to detect a postcode format for the region '{$locale->getRegion()}'");
}
$this->setFormat($format);
return $this;
}
/**
* Returns the set postal code format
*
* @return string
*/
public function getFormat()
{
return $this->_format;
}
/**
* Sets a self defined postal format as regex
*
* @param string $format
* @throws Postman_Zend_Validate_Exception On empty format
* @return Postman_Zend_Validate_PostCode Provides a fluent interface
*/
public function setFormat($format)
{
if (empty($format) || !is_string($format)) {
require_once 'Zend/Validate/Exception.php';
throw new Postman_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;
}
/**
* Defined by Postman_Zend_Validate_Interface
*
* Returns true if and only if $value is a valid postalcode
*
* @param string $value
* @return boolean
*/
public function isValid($value)
{
$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;
}
}
|
