-
Notifications
You must be signed in to change notification settings - Fork 0
/
FormatRules.php
executable file
·344 lines (296 loc) · 8.5 KB
/
FormatRules.php
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
<?php
/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <admin@codeigniter.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/
namespace CodeIgniter\Validation;
use DateTime;
/**
* Format validation Rules.
*/
class FormatRules
{
/**
* Alpha
*/
public function alpha(?string $str = null): bool
{
return ctype_alpha($str ?? '');
}
/**
* Alpha with spaces.
*
* @param string|null $value Value.
*
* @return bool True if alpha with spaces, else false.
*/
public function alpha_space(?string $value = null): bool
{
if ($value === null) {
return true;
}
// @see https://regex101.com/r/LhqHPO/1
return (bool) preg_match('/\A[A-Z ]+\z/i', $value);
}
/**
* Alphanumeric with underscores and dashes
*
* @see https://regex101.com/r/XfVY3d/1
*/
public function alpha_dash(?string $str = null): bool
{
if ($str === null) {
return false;
}
return preg_match('/\A[a-z0-9_-]+\z/i', $str) === 1;
}
/**
* Alphanumeric, spaces, and a limited set of punctuation characters.
* Accepted punctuation characters are: ~ tilde, ! exclamation,
* # number, $ dollar, % percent, & ampersand, * asterisk, - dash,
* _ underscore, + plus, = equals, | vertical bar, : colon, . period
* ~ ! # $ % & * - _ + = | : .
*
* @param string|null $str
*
* @return bool
*
* @see https://regex101.com/r/6N8dDY/1
*/
public function alpha_numeric_punct($str)
{
if ($str === null) {
return false;
}
return preg_match('/\A[A-Z0-9 ~!#$%\&\*\-_+=|:.]+\z/i', $str) === 1;
}
/**
* Alphanumeric
*/
public function alpha_numeric(?string $str = null): bool
{
return ctype_alnum($str ?? '');
}
/**
* Alphanumeric w/ spaces
*/
public function alpha_numeric_space(?string $str = null): bool
{
// @see https://regex101.com/r/0AZDME/1
return (bool) preg_match('/\A[A-Z0-9 ]+\z/i', $str ?? '');
}
/**
* Any type of string
*
* Note: we specifically do NOT type hint $str here so that
* it doesn't convert numbers into strings.
*
* @param string|null $str
*/
public function string($str = null): bool
{
return is_string($str);
}
/**
* Decimal number
*/
public function decimal(?string $str = null): bool
{
// @see https://regex101.com/r/HULifl/2/
return (bool) preg_match('/\A[-+]?\d{0,}\.?\d+\z/', $str ?? '');
}
/**
* String of hexidecimal characters
*/
public function hex(?string $str = null): bool
{
return ctype_xdigit($str ?? '');
}
/**
* Integer
*/
public function integer(?string $str = null): bool
{
return (bool) preg_match('/\A[\-+]?\d+\z/', $str ?? '');
}
/**
* Is a Natural number (0,1,2,3, etc.)
*/
public function is_natural(?string $str = null): bool
{
return ctype_digit($str ?? '');
}
/**
* Is a Natural number, but not a zero (1,2,3, etc.)
*/
public function is_natural_no_zero(?string $str = null): bool
{
return $str !== '0' && ctype_digit($str ?? '');
}
/**
* Numeric
*/
public function numeric(?string $str = null): bool
{
// @see https://regex101.com/r/bb9wtr/2
return (bool) preg_match('/\A[\-+]?\d*\.?\d+\z/', $str ?? '');
}
/**
* Compares value against a regular expression pattern.
*/
public function regex_match(?string $str, string $pattern): bool
{
if (strpos($pattern, '/') !== 0) {
$pattern = "/{$pattern}/";
}
return (bool) preg_match($pattern, $str ?? '');
}
/**
* Validates that the string is a valid timezone as per the
* timezone_identifiers_list function.
*
* @see http://php.net/manual/en/datetimezone.listidentifiers.php
*
* @param string $str
*/
public function timezone(?string $str = null): bool
{
return in_array($str ?? '', timezone_identifiers_list(), true);
}
/**
* Valid Base64
*
* Tests a string for characters outside of the Base64 alphabet
* as defined by RFC 2045 http://www.faqs.org/rfcs/rfc2045
*
* @param string $str
*/
public function valid_base64(?string $str = null): bool
{
if ($str === null) {
return false;
}
return base64_encode(base64_decode($str, true)) === $str;
}
/**
* Valid JSON
*
* @param string $str
*/
public function valid_json(?string $str = null): bool
{
json_decode($str ?? '');
return json_last_error() === JSON_ERROR_NONE;
}
/**
* Checks for a correctly formatted email address
*
* @param string $str
*/
public function valid_email(?string $str = null): bool
{
// @see https://regex101.com/r/wlJG1t/1/
if (function_exists('idn_to_ascii') && defined('INTL_IDNA_VARIANT_UTS46') && preg_match('#\A([^@]+)@(.+)\z#', $str ?? '', $matches)) {
$str = $matches[1] . '@' . idn_to_ascii($matches[2], 0, INTL_IDNA_VARIANT_UTS46);
}
return (bool) filter_var($str, FILTER_VALIDATE_EMAIL);
}
/**
* Validate a comma-separated list of email addresses.
*
* Example:
* valid_emails[one@example.com,two@example.com]
*
* @param string $str
*/
public function valid_emails(?string $str = null): bool
{
foreach (explode(',', $str ?? '') as $email) {
$email = trim($email);
if ($email === '') {
return false;
}
if ($this->valid_email($email) === false) {
return false;
}
}
return true;
}
/**
* Validate an IP address (human readable format or binary string - inet_pton)
*
* @param string|null $which IP protocol: 'ipv4' or 'ipv6'
*/
public function valid_ip(?string $ip = null, ?string $which = null): bool
{
if (empty($ip)) {
return false;
}
switch (strtolower($which ?? '')) {
case 'ipv4':
$which = FILTER_FLAG_IPV4;
break;
case 'ipv6':
$which = FILTER_FLAG_IPV6;
break;
default:
$which = 0;
}
return filter_var($ip, FILTER_VALIDATE_IP, $which) !== false
|| (! ctype_print($ip) && filter_var(inet_ntop($ip), FILTER_VALIDATE_IP, $which) !== false);
}
/**
* Checks a string to ensure it is (loosely) a URL.
*
* Warning: this rule will pass basic strings like
* "banana"; use valid_url_strict for a stricter rule.
*/
public function valid_url(?string $str = null): bool
{
if (empty($str)) {
return false;
}
if (preg_match('/^(?:([^:]*)\:)?\/\/(.+)$/', $str, $matches)) {
if (! in_array($matches[1], ['http', 'https'], true)) {
return false;
}
$str = $matches[2];
}
$str = 'http://' . $str;
return filter_var($str, FILTER_VALIDATE_URL) !== false;
}
/**
* Checks a URL to ensure it's formed correctly.
*
* @param string|null $validSchemes comma separated list of allowed schemes
*/
public function valid_url_strict(?string $str = null, ?string $validSchemes = null): bool
{
if (empty($str)) {
return false;
}
$scheme = strtolower(parse_url($str, PHP_URL_SCHEME) ?? ''); // absent scheme gives null
$validSchemes = explode(
',',
strtolower($validSchemes ?? 'http,https')
);
return in_array($scheme, $validSchemes, true)
&& filter_var($str, FILTER_VALIDATE_URL) !== false;
}
/**
* Checks for a valid date and matches a given date format
*/
public function valid_date(?string $str = null, ?string $format = null): bool
{
if (empty($format)) {
return strtotime($str) !== false;
}
$date = DateTime::createFromFormat($format, $str);
$errors = DateTime::getLastErrors();
return $date !== false && $errors !== false && $errors['warning_count'] === 0 && $errors['error_count'] === 0;
}
}