/[cvs]/nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/FormProcessing/FormValidation.html
ViewVC logotype

Contents of /nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/FormProcessing/FormValidation.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.2 - (show annotations)
Sat Sep 20 00:37:11 2003 UTC (21 years ago) by jonen
Branch: MAIN
Changes since 1.1: +1967 -1826 lines
File MIME type: text/html
+ updated whole phphtmllib to v2.3.0

1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <!-- template designed by Marco Von Ballmoos -->
6 <title>Docs For Class FormValidation</title>
7 <link rel="stylesheet" href="../../media/stylesheet.css" />
8 <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9 </head>
10 <body>
11 <div class="page-body">
12 <h2 class="class-name">Class FormValidation</h2>
13
14 <a name="sec-description"></a>
15 <div class="info-box">
16 <div class="info-box-title">Description</div>
17 <div class="nav-bar">
18 <span class="disabled">Description</span> |
19 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
20 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
21
22 </div>
23 <div class="info-box-body">
24 <!-- ========== Info from phpDoc block ========= -->
25 <p class="short-description">This is the base validation class that contains some basic FormElement validation methods.</p>
26 <p class="notes">
27 Located in <a class="field" href="_form_FormValidation_inc.html">Program_Root/form/FormValidation.inc</a> (line <span class="field">33</span>)
28 </p>
29
30
31 <pre></pre>
32
33 </div>
34 </div>
35
36
37 <a name="sec-var-summary"></a>
38 <div class="info-box">
39 <div class="info-box-title">Variable Summary</span></div>
40 <div class="nav-bar">
41 <a href="#sec-description">Description</a> |
42 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
43 |
44 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
45
46 </div>
47 <div class="info-box-body">
48 <div class="var-summary">
49 <div class="var-title">
50 <span class="var-type">mixed</span>
51 <a href="#$_error_code" title="details" class="var-name">$_error_code</a>
52 </div>
53 <div class="var-title">
54 <span class="var-type">mixed</span>
55 <a href="#$_error_message" title="details" class="var-name">$_error_message</a>
56 </div>
57 <div class="var-title">
58 <span class="var-type">mixed</span>
59 <a href="#$_FormErrors" title="details" class="var-name">$_FormErrors</a>
60 </div>
61 </div>
62 </div>
63 </div>
64
65 <a name="sec-method-summary"></a>
66 <div class="info-box">
67 <div class="info-box-title">Method Summary</span></div>
68 <div class="nav-bar">
69 <a href="#sec-description">Description</a> |
70 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
71
72 |
73 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
74 </div>
75 <div class="info-box-body">
76 <div class="method-summary">
77
78 <div class="method-definition">
79 <span class="method-result">void</span>
80 <a href="#FormValidation" title="details" class="method-name">FormValidation</a>
81 (<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormErrors.html">FormErrors</a></span>&nbsp;<span class="var-name">&$error_obj</span>)
82 </div>
83
84 <div class="method-definition">
85 <span class="method-result">void</span>
86 <a href="#array_hasempty" title="details" class="method-name">array_hasempty</a>
87 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$a</span>)
88 </div>
89
90 <div class="method-definition">
91 <span class="method-result">string</span>
92 <a href="#get_error_code" title="details" class="method-name">get_error_code</a>
93 ()
94 </div>
95
96 <div class="method-definition">
97 <span class="method-result">string</span>
98 <a href="#get_error_message" title="details" class="method-name">get_error_message</a>
99 ()
100 </div>
101
102 <div class="method-definition">
103 <span class="method-result">boolean</span>
104 <a href="#is_alphanum" title="details" class="method-name">is_alphanum</a>
105 (<span class="var-type">string</span>&nbsp;<span class="var-name">$str</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$from</span> = <span class="var-default">""</span>])
106 </div>
107
108 <div class="method-definition">
109 <span class="method-result">TRUE</span>
110 <a href="#is_alphanumstring" title="details" class="method-name">is_alphanumstring</a>
111 (<span class="var-type">string</span>&nbsp;<span class="var-name">$str</span>)
112 </div>
113
114 <div class="method-definition">
115 <span class="method-result">TRUE</span>
116 <a href="#is_ccexp" title="details" class="method-name">is_ccexp</a>
117 (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$split_by</span> = <span class="var-default">"-"</span>])
118 </div>
119
120 <div class="method-definition">
121 <span class="method-result">TRUE</span>
122 <a href="#is_companyname" title="details" class="method-name">is_companyname</a>
123 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
124 </div>
125
126 <div class="method-definition">
127 <span class="method-result">TRUE</span>
128 <a href="#is_confirm_password" title="details" class="method-name">is_confirm_password</a>
129 (<span class="var-type">string</span>&nbsp;<span class="var-name">$confirmpassword</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$password</span>)
130 </div>
131
132 <div class="method-definition">
133 <span class="method-result">TRUE</span>
134 <a href="#is_countrycode" title="details" class="method-name">is_countrycode</a>
135 (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
136 </div>
137
138 <div class="method-definition">
139 <span class="method-result">TRUE</span>
140 <a href="#is_date" title="details" class="method-name">is_date</a>
141 (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$split_by</span> = <span class="var-default">"-"</span>])
142 </div>
143
144 <div class="method-definition">
145 <span class="method-result">TRUE</span>
146 <a href="#is_dateday" title="details" class="method-name">is_dateday</a>
147 (<span class="var-type">string</span>&nbsp;<span class="var-name">$day</span>)
148 </div>
149
150 <div class="method-definition">
151 <span class="method-result">TRUE</span>
152 <a href="#is_datemonth" title="details" class="method-name">is_datemonth</a>
153 (<span class="var-type">string</span>&nbsp;<span class="var-name">$month</span>)
154 </div>
155
156 <div class="method-definition">
157 <span class="method-result">TRUE</span>
158 <a href="#is_datetime" title="details" class="method-name">is_datetime</a>
159 (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
160 </div>
161
162 <div class="method-definition">
163 <span class="method-result">TRUE</span>
164 <a href="#is_dateyear" title="details" class="method-name">is_dateyear</a>
165 (<span class="var-type">string</span>&nbsp;<span class="var-name">$year</span>)
166 </div>
167
168 <div class="method-definition">
169 <span class="method-result">TRUE</span>
170 <a href="#is_domainname" title="details" class="method-name">is_domainname</a>
171 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$forbid_www</span> = <span class="var-default">FALSE</span>])
172 </div>
173
174 <div class="method-definition">
175 <span class="method-result">TRUE</span>
176 <a href="#is_email" title="details" class="method-name">is_email</a>
177 (<span class="var-type">string</span>&nbsp;<span class="var-name">$email</span>)
178 </div>
179
180 <div class="method-definition">
181 <span class="method-result">TRUE</span>
182 <a href="#is_firstname" title="details" class="method-name">is_firstname</a>
183 (<span class="var-type">string</span>&nbsp;<span class="var-name">$firstname</span>)
184 </div>
185
186 <div class="method-definition">
187 <span class="method-result">TRUE</span>
188 <a href="#is_float" title="details" class="method-name">is_float</a>
189 (<span class="var-type">string</span>&nbsp;<span class="var-name">$number</span>)
190 </div>
191
192 <div class="method-definition">
193 <span class="method-result">TRUE</span>
194 <a href="#is_higherzeronumber" title="details" class="method-name">is_higherzeronumber</a>
195 (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
196 </div>
197
198 <div class="method-definition">
199 <span class="method-result">void</span>
200 <a href="#is_host" title="details" class="method-name">is_host</a>
201 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$host</span>)
202 </div>
203
204 <div class="method-definition">
205 <span class="method-result">TRUE</span>
206 <a href="#is_hostemail" title="details" class="method-name">is_hostemail</a>
207 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
208 </div>
209
210 <div class="method-definition">
211 <span class="method-result">TRUE</span>
212 <a href="#is_hostip" title="details" class="method-name">is_hostip</a>
213 (<span class="var-type">string</span>&nbsp;<span class="var-name">$hostip</span>)
214 </div>
215
216 <div class="method-definition">
217 <span class="method-result">void</span>
218 <a href="#is_hostlist" title="details" class="method-name">is_hostlist</a>
219 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$hostlist</span>)
220 </div>
221
222 <div class="method-definition">
223 <span class="method-result">TRUE</span>
224 <a href="#is_hostname" title="details" class="method-name">is_hostname</a>
225 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
226 </div>
227
228 <div class="method-definition">
229 <span class="method-result">TRUE</span>
230 <a href="#is_ip" title="details" class="method-name">is_ip</a>
231 (<span class="var-type">string</span>&nbsp;<span class="var-name">$ip</span>)
232 </div>
233
234 <div class="method-definition">
235 <span class="method-result">TRUE</span>
236 <a href="#is_lastname" title="details" class="method-name">is_lastname</a>
237 (<span class="var-type">string</span>&nbsp;<span class="var-name">$lastname</span>)
238 </div>
239
240 <div class="method-definition">
241 <span class="method-result">TRUE</span>
242 <a href="#is_leapyear" title="details" class="method-name">is_leapyear</a>
243 (<span class="var-type">string</span>&nbsp;<span class="var-name">$yyyy</span>)
244 </div>
245
246 <div class="method-definition">
247 <span class="method-result">TRUE</span>
248 <a href="#is_manyemails" title="details" class="method-name">is_manyemails</a>
249 (<span class="var-type">string</span>&nbsp;<span class="var-name">$emails</span>)
250 </div>
251
252 <div class="method-definition">
253 <span class="method-result">TRUE</span>
254 <a href="#is_money" title="details" class="method-name">is_money</a>
255 (<span class="var-type">string</span>&nbsp;<span class="var-name">$money</span>)
256 </div>
257
258 <div class="method-definition">
259 <span class="method-result">TRUE</span>
260 <a href="#is_name" title="details" class="method-name">is_name</a>
261 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
262 </div>
263
264 <div class="method-definition">
265 <span class="method-result">TRUE</span>
266 <a href="#is_notempty" title="details" class="method-name">is_notempty</a>
267 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
268 </div>
269
270 <div class="method-definition">
271 <span class="method-result">boolean</span>
272 <a href="#is_num" title="details" class="method-name">is_num</a>
273 (<span class="var-type">string</span>&nbsp;<span class="var-name">$str</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$from</span> = <span class="var-default">""</span>])
274 </div>
275
276 <div class="method-definition">
277 <span class="method-result">TRUE</span>
278 <a href="#is_number" title="details" class="method-name">is_number</a>
279 (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
280 </div>
281
282 <div class="method-definition">
283 <span class="method-result">TRUE</span>
284 <a href="#is_partial_domainname" title="details" class="method-name">is_partial_domainname</a>
285 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
286 </div>
287
288 <div class="method-definition">
289 <span class="method-result">TRUE</span>
290 <a href="#is_partial_ip" title="details" class="method-name">is_partial_ip</a>
291 (<span class="var-type">string</span>&nbsp;<span class="var-name">$ip</span>)
292 </div>
293
294 <div class="method-definition">
295 <span class="method-result">TRUE</span>
296 <a href="#is_password" title="details" class="method-name">is_password</a>
297 (<span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>)
298 </div>
299
300 <div class="method-definition">
301 <span class="method-result">TRUE</span>
302 <a href="#is_path" title="details" class="method-name">is_path</a>
303 (<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>)
304 </div>
305
306 <div class="method-definition">
307 <span class="method-result">TRUE</span>
308 <a href="#is_price" title="details" class="method-name">is_price</a>
309 (<span class="var-type">string</span>&nbsp;<span class="var-name">$price</span>)
310 </div>
311
312 <div class="method-definition">
313 <span class="method-result">void</span>
314 <a href="#is_range" title="details" class="method-name">is_range</a>
315 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$size</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$min</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$max</span>)
316 </div>
317
318 <div class="method-definition">
319 <span class="method-result">TRUE</span>
320 <a href="#is_standalone_hostname" title="details" class="method-name">is_standalone_hostname</a>
321 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
322 </div>
323
324 <div class="method-definition">
325 <span class="method-result">TRUE</span>
326 <a href="#is_strict_url" title="details" class="method-name">is_strict_url</a>
327 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
328 </div>
329
330 <div class="method-definition">
331 <span class="method-result">TRUE</span>
332 <a href="#is_time" title="details" class="method-name">is_time</a>
333 (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
334 </div>
335
336 <div class="method-definition">
337 <span class="method-result">TRUE</span>
338 <a href="#is_title" title="details" class="method-name">is_title</a>
339 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
340 </div>
341
342 <div class="method-definition">
343 <span class="method-result">TRUE</span>
344 <a href="#is_url" title="details" class="method-name">is_url</a>
345 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
346 </div>
347
348 <div class="method-definition">
349 <span class="method-result">TRUE</span>
350 <a href="#is_urlpath" title="details" class="method-name">is_urlpath</a>
351 (<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>)
352 </div>
353
354 <div class="method-definition">
355 <span class="method-result">TRUE</span>
356 <a href="#is_username" title="details" class="method-name">is_username</a>
357 (<span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>)
358 </div>
359
360 <div class="method-definition">
361 <span class="method-result">TRUE</span>
362 <a href="#is_valid_domain" title="details" class="method-name">is_valid_domain</a>
363 (<span class="var-type">string</span>&nbsp;<span class="var-name">$domain_value</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$allow_www</span> = <span class="var-default">false</span>])
364 </div>
365
366 <div class="method-definition">
367 <span class="method-result">TRUE</span>
368 <a href="#is_within_range" title="details" class="method-name">is_within_range</a>
369 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$size</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$start</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$end</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$error</span> = <span class="var-default">FALSE</span>])
370 </div>
371
372 <div class="method-definition">
373 <span class="method-result">TRUE</span>
374 <a href="#is_zero_onehundred" title="details" class="method-name">is_zero_onehundred</a>
375 (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
376 </div>
377
378 <div class="method-definition">
379 <span class="method-result">TRUE</span>
380 <a href="#is_zip" title="details" class="method-name">is_zip</a>
381 (<span class="var-type">string</span>&nbsp;<span class="var-name">$zip</span>)
382 </div>
383
384 <div class="method-definition">
385 <span class="method-result">FALSE</span>
386 <a href="#_error" title="details" class="method-name">_error</a>
387 (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$message</span> = <span class="var-default">NULL</span>])
388 </div>
389 </div>
390 </div>
391 </div>
392
393 <a name="sec-vars"></a>
394 <div class="info-box">
395 <div class="info-box-title">Variables</div>
396 <div class="nav-bar">
397 <a href="#sec-description">Description</a> |
398 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
399
400
401 |
402 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
403
404 </div>
405 <div class="info-box-body">
406 <a name="var$_error_code" id="$_error_code"><!-- --></A>
407 <div class="evenrow">
408
409 <div class="var-header">
410 <span class="var-title">
411 <span class="var-type">mixed</span>
412 <span class="var-name">$_error_code</span>
413 = <span class="var-default"> ''</span> (line <span class="line-number">38</span>)
414 </span>
415 </div>
416
417 <!-- ========== Info from phpDoc block ========= -->
418 <p class="short-description">This holds the last error code found</p>
419
420
421
422
423
424 </div>
425 <a name="var$_error_message" id="$_error_message"><!-- --></A>
426 <div class="oddrow">
427
428 <div class="var-header">
429 <span class="var-title">
430 <span class="var-type">mixed</span>
431 <span class="var-name">$_error_message</span>
432 = <span class="var-default"> ''</span> (line <span class="line-number">43</span>)
433 </span>
434 </div>
435
436 <!-- ========== Info from phpDoc block ========= -->
437 <p class="short-description">This holds the last error message</p>
438
439
440
441
442
443 </div>
444 <a name="var$_FormErrors" id="$_FormErrors"><!-- --></A>
445 <div class="evenrow">
446
447 <div class="var-header">
448 <span class="var-title">
449 <span class="var-type">mixed</span>
450 <span class="var-name">$_FormErrors</span>
451 = <span class="var-default"> NULL</span> (line <span class="line-number">48</span>)
452 </span>
453 </div>
454
455 <!-- ========== Info from phpDoc block ========= -->
456 <p class="short-description">This is the FormErrors object</p>
457
458
459
460
461
462 </div>
463
464 </div>
465 </div>
466
467 <a name="sec-methods"></a>
468 <div class="info-box">
469 <div class="info-box-title">Methods</div>
470 <div class="nav-bar">
471 <a href="#sec-description">Description</a> |
472 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
473 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
474
475 </div>
476 <div class="info-box-body">
477 <A NAME='method_detail'></A>
478 <a name="methodFormValidation" id="FormValidation"><!-- --></a>
479 <div class="oddrow">
480
481 <div class="method-header">
482 <span class="method-title">Constructor FormValidation</span> (line <span class="line-number">58</span>)
483 </div>
484
485 <!-- ========== Info from phpDoc block ========= -->
486 <p class="short-description">The constructor used to set the form errors object used by this class to do error text lookups</p>
487
488 <div class="method-signature">
489 <span class="method-result">void</span>
490 <span class="method-name">
491 FormValidation
492 </span>
493 (<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormErrors.html">FormErrors</a></span>&nbsp;<span class="var-name">&$error_obj</span>)
494 </div>
495
496 <ul class="parameters">
497 <li>
498 <span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormErrors.html">FormErrors</a></span>
499 <span class="var-name">&$error_obj</span><span class="var-description">: <p>object</p></span> </li>
500 </ul>
501
502
503 </div>
504 <a name="methodarray_hasempty" id="array_hasempty"><!-- --></a>
505 <div class="evenrow">
506
507 <div class="method-header">
508 <span class="method-title">array_hasempty</span> (line <span class="line-number">69</span>)
509 </div>
510
511 <!-- ========== Info from phpDoc block ========= -->
512 <p class="short-description">This method checks to make sure an array doesn't have an empty element.</p>
513
514 <div class="method-signature">
515 <span class="method-result">void</span>
516 <span class="method-name">
517 array_hasempty
518 </span>
519 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$a</span>)
520 </div>
521
522
523
524 </div>
525 <a name="methodget_error_code" id="get_error_code"><!-- --></a>
526 <div class="oddrow">
527
528 <div class="method-header">
529 <span class="method-title">get_error_code</span> (line <span class="line-number">109</span>)
530 </div>
531
532 <!-- ========== Info from phpDoc block ========= -->
533 <p class="short-description">This method returns the error code from the last validation error found.</p>
534
535 <div class="method-signature">
536 <span class="method-result">string</span>
537 <span class="method-name">
538 get_error_code
539 </span>
540 ()
541 </div>
542
543
544
545 </div>
546 <a name="methodget_error_message" id="get_error_message"><!-- --></a>
547 <div class="evenrow">
548
549 <div class="method-header">
550 <span class="method-title">get_error_message</span> (line <span class="line-number">120</span>)
551 </div>
552
553 <!-- ========== Info from phpDoc block ========= -->
554 <p class="short-description">This method returns the error message from the last validation error found.</p>
555
556 <div class="method-signature">
557 <span class="method-result">string</span>
558 <span class="method-name">
559 get_error_message
560 </span>
561 ()
562 </div>
563
564
565
566 </div>
567 <a name="methodis_alphanum" id="is_alphanum"><!-- --></a>
568 <div class="oddrow">
569
570 <div class="method-header">
571 <span class="method-title">is_alphanum</span> (line <span class="line-number">152</span>)
572 </div>
573
574 <!-- ========== Info from phpDoc block ========= -->
575 <p class="short-description">This function checks if the given string contains alphabetical characters or numbers.</p>
576 <p class="description"><p>It also checks for the allowed additional characters.</p></p>
577 <ul class="tags">
578 <li><span class="field">return:</span> <p>FALSE - if any other extraneous characters are found TRUE upon succes.</p></li>
579 </ul>
580
581 <div class="method-signature">
582 <span class="method-result">boolean</span>
583 <span class="method-name">
584 is_alphanum
585 </span>
586 (<span class="var-type">string</span>&nbsp;<span class="var-name">$str</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$from</span> = <span class="var-default">""</span>])
587 </div>
588
589 <ul class="parameters">
590 <li>
591 <span class="var-type">string</span>
592 <span class="var-name">$str</span><span class="var-description">: <p>- the string to check</p></span> </li>
593 <li>
594 <span class="var-type">string</span>
595 <span class="var-name">$from</span><span class="var-description">: <p>- list of individual characters to allow besides a-zA-Z</p></span> </li>
596 </ul>
597
598
599 </div>
600 <a name="methodis_alphanumstring" id="is_alphanumstring"><!-- --></a>
601 <div class="evenrow">
602
603 <div class="method-header">
604 <span class="method-title">is_alphanumstring</span> (line <span class="line-number">265</span>)
605 </div>
606
607 <!-- ========== Info from phpDoc block ========= -->
608 <p class="short-description">This method validates a string as containing only letters and numbers</p>
609 <ul class="tags">
610 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
611 </ul>
612
613 <div class="method-signature">
614 <span class="method-result">TRUE</span>
615 <span class="method-name">
616 is_alphanumstring
617 </span>
618 (<span class="var-type">string</span>&nbsp;<span class="var-name">$str</span>)
619 </div>
620
621 <ul class="parameters">
622 <li>
623 <span class="var-type">string</span>
624 <span class="var-name">$str</span><span class="var-description">: <p>- the value to validate</p></span> </li>
625 </ul>
626
627
628 </div>
629 <a name="methodis_ccexp" id="is_ccexp"><!-- --></a>
630 <div class="oddrow">
631
632 <div class="method-header">
633 <span class="method-title">is_ccexp</span> (line <span class="line-number">1017</span>)
634 </div>
635
636 <!-- ========== Info from phpDoc block ========= -->
637 <p class="short-description">This tests a string as a valid credit card expiration date.</p>
638 <p class="description"><p>You can pass in an optional date delimiter string. The default is -</p></p>
639 <ul class="tags">
640 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
641 </ul>
642
643 <div class="method-signature">
644 <span class="method-result">TRUE</span>
645 <span class="method-name">
646 is_ccexp
647 </span>
648 (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$split_by</span> = <span class="var-default">"-"</span>])
649 </div>
650
651 <ul class="parameters">
652 <li>
653 <span class="var-type">string</span>
654 <span class="var-name">$value</span><span class="var-description">: <p>- the value to validate</p></span> </li>
655 </ul>
656
657
658 </div>
659 <a name="methodis_companyname" id="is_companyname"><!-- --></a>
660 <div class="evenrow">
661
662 <div class="method-header">
663 <span class="method-title">is_companyname</span> (line <span class="line-number">634</span>)
664 </div>
665
666 <!-- ========== Info from phpDoc block ========= -->
667 <p class="short-description">This validates a string as a valid Company name.</p>
668 <p class="description"><p>It is the same as is_name, with the exception of allowing .</p></p>
669 <ul class="tags">
670 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
671 </ul>
672
673 <div class="method-signature">
674 <span class="method-result">TRUE</span>
675 <span class="method-name">
676 is_companyname
677 </span>
678 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
679 </div>
680
681 <ul class="parameters">
682 <li>
683 <span class="var-type">string</span>
684 <span class="var-name">$name</span><span class="var-description">: <p>- the value to validate</p></span> </li>
685 </ul>
686
687
688 </div>
689 <a name="methodis_confirm_password" id="is_confirm_password"><!-- --></a>
690 <div class="oddrow">
691
692 <div class="method-header">
693 <span class="method-title">is_confirm_password</span> (line <span class="line-number">693</span>)
694 </div>
695
696 <!-- ========== Info from phpDoc block ========= -->
697 <p class="short-description">This makes sure that 2 password strings are exactly alike.</p>
698 <ul class="tags">
699 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
700 </ul>
701
702 <div class="method-signature">
703 <span class="method-result">TRUE</span>
704 <span class="method-name">
705 is_confirm_password
706 </span>
707 (<span class="var-type">string</span>&nbsp;<span class="var-name">$confirmpassword</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$password</span>)
708 </div>
709
710 <ul class="parameters">
711 <li>
712 <span class="var-type">string</span>
713 <span class="var-name">$confirmpassword</span><span class="var-description">: <p>- the value to validate</p></span> </li>
714 </ul>
715
716
717 </div>
718 <a name="methodis_countrycode" id="is_countrycode"><!-- --></a>
719 <div class="evenrow">
720
721 <div class="method-header">
722 <span class="method-title">is_countrycode</span> (line <span class="line-number">1048</span>)
723 </div>
724
725 <!-- ========== Info from phpDoc block ========= -->
726 <p class="short-description">This validates a string as a valid &quot;country code&quot; which is a 2 alphanumerical character string</p>
727 <ul class="tags">
728 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
729 </ul>
730
731 <div class="method-signature">
732 <span class="method-result">TRUE</span>
733 <span class="method-name">
734 is_countrycode
735 </span>
736 (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
737 </div>
738
739 <ul class="parameters">
740 <li>
741 <span class="var-type">string</span>
742 <span class="var-name">$value</span><span class="var-description">: <p>- the value to validate</p></span> </li>
743 </ul>
744
745
746 </div>
747 <a name="methodis_date" id="is_date"><!-- --></a>
748 <div class="oddrow">
749
750 <div class="method-header">
751 <span class="method-title">is_date</span> (line <span class="line-number">833</span>)
752 </div>
753
754 <!-- ========== Info from phpDoc block ========= -->
755 <p class="short-description">This validates a atring as a valid date format You can provide a seperator string that seperates the fields</p>
756 <p class="description"><p>NOTE: date is in YYYY-MO-DY format</p></p>
757 <ul class="tags">
758 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
759 </ul>
760
761 <div class="method-signature">
762 <span class="method-result">TRUE</span>
763 <span class="method-name">
764 is_date
765 </span>
766 (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$split_by</span> = <span class="var-default">"-"</span>])
767 </div>
768
769 <ul class="parameters">
770 <li>
771 <span class="var-type">string</span>
772 <span class="var-name">$value</span><span class="var-description">: <p>- the value to validate</p></span> </li>
773 </ul>
774
775
776 </div>
777 <a name="methodis_dateday" id="is_dateday"><!-- --></a>
778 <div class="evenrow">
779
780 <div class="method-header">
781 <span class="method-title">is_dateday</span> (line <span class="line-number">872</span>)
782 </div>
783
784 <!-- ========== Info from phpDoc block ========= -->
785 <p class="short-description">This validates a string as a valid day of a month It has to be greater then 0 and less then 31</p>
786 <ul class="tags">
787 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
788 </ul>
789
790 <div class="method-signature">
791 <span class="method-result">TRUE</span>
792 <span class="method-name">
793 is_dateday
794 </span>
795 (<span class="var-type">string</span>&nbsp;<span class="var-name">$day</span>)
796 </div>
797
798 <ul class="parameters">
799 <li>
800 <span class="var-type">string</span>
801 <span class="var-name">$day</span><span class="var-description">: <p>- the value to validate</p></span> </li>
802 </ul>
803
804
805 </div>
806 <a name="methodis_datemonth" id="is_datemonth"><!-- --></a>
807 <div class="oddrow">
808
809 <div class="method-header">
810 <span class="method-title">is_datemonth</span> (line <span class="line-number">885</span>)
811 </div>
812
813 <!-- ========== Info from phpDoc block ========= -->
814 <p class="short-description">This validates a string as a valid month of the year between 1 and 12 inclusive is_datemonth - checks whether its a proper month</p>
815 <ul class="tags">
816 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
817 </ul>
818
819 <div class="method-signature">
820 <span class="method-result">TRUE</span>
821 <span class="method-name">
822 is_datemonth
823 </span>
824 (<span class="var-type">string</span>&nbsp;<span class="var-name">$month</span>)
825 </div>
826
827 <ul class="parameters">
828 <li>
829 <span class="var-type">string</span>
830 <span class="var-name">$month</span><span class="var-description">: <p>- the value to validate</p></span> </li>
831 </ul>
832
833
834 </div>
835 <a name="methodis_datetime" id="is_datetime"><!-- --></a>
836 <div class="evenrow">
837
838 <div class="method-header">
839 <span class="method-title">is_datetime</span> (line <span class="line-number">918</span>)
840 </div>
841
842 <!-- ========== Info from phpDoc block ========= -->
843 <p class="short-description">This validates an array of values as a valid date time</p>
844 <p class="description"><p>NOTE: array must contain array( &quot;month&quot; =&gt; VALUE, &quot;day&quot; =&gt; VALUE, &quot;year&quot; =&gt; VALUE, &quot;hour&quot; =&gt; VALUE, &quot;minutes&quot; =&gt; VALUE, &quot;seconds&quot; =&gt; VALUE);</p></p>
845 <ul class="tags">
846 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
847 </ul>
848
849 <div class="method-signature">
850 <span class="method-result">TRUE</span>
851 <span class="method-name">
852 is_datetime
853 </span>
854 (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
855 </div>
856
857 <ul class="parameters">
858 <li>
859 <span class="var-type">string</span>
860 <span class="var-name">$value</span><span class="var-description">: <p>- the value to validate</p></span> </li>
861 </ul>
862
863
864 </div>
865 <a name="methodis_dateyear" id="is_dateyear"><!-- --></a>
866 <div class="oddrow">
867
868 <div class="method-header">
869 <span class="method-title">is_dateyear</span> (line <span class="line-number">897</span>)
870 </div>
871
872 <!-- ========== Info from phpDoc block ========= -->
873 <p class="short-description">See if the year is within 1800 and 3000</p>
874 <ul class="tags">
875 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
876 </ul>
877
878 <div class="method-signature">
879 <span class="method-result">TRUE</span>
880 <span class="method-name">
881 is_dateyear
882 </span>
883 (<span class="var-type">string</span>&nbsp;<span class="var-name">$year</span>)
884 </div>
885
886 <ul class="parameters">
887 <li>
888 <span class="var-type">string</span>
889 <span class="var-name">$year</span><span class="var-description">: <p>- the value to validate</p></span> </li>
890 </ul>
891
892
893 </div>
894 <a name="methodis_domainname" id="is_domainname"><!-- --></a>
895 <div class="evenrow">
896
897 <div class="method-header">
898 <span class="method-title">is_domainname</span> (line <span class="line-number">312</span>)
899 </div>
900
901 <!-- ========== Info from phpDoc block ========= -->
902 <p class="short-description">This method validates a string for a valid hostname for a machine.</p>
903 <ul class="tags">
904 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
905 </ul>
906
907 <div class="method-signature">
908 <span class="method-result">TRUE</span>
909 <span class="method-name">
910 is_domainname
911 </span>
912 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$forbid_www</span> = <span class="var-default">FALSE</span>])
913 </div>
914
915 <ul class="parameters">
916 <li>
917 <span class="var-type">string</span>
918 <span class="var-name">$name</span><span class="var-description">: <p>- the value to validate</p></span> </li>
919 </ul>
920
921
922 </div>
923 <a name="methodis_email" id="is_email"><!-- --></a>
924 <div class="oddrow">
925
926 <div class="method-header">
927 <span class="method-title">is_email</span> (line <span class="line-number">726</span>)
928 </div>
929
930 <!-- ========== Info from phpDoc block ========= -->
931 <p class="short-description">This function validates a single email address.</p>
932 <p class="description"><p>It supports email addresses in the format of jane@blah.com or &quot;Jane Doe &lt;jane@blah.com&gt;&quot;</p></p>
933 <ul class="tags">
934 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
935 </ul>
936
937 <div class="method-signature">
938 <span class="method-result">TRUE</span>
939 <span class="method-name">
940 is_email
941 </span>
942 (<span class="var-type">string</span>&nbsp;<span class="var-name">$email</span>)
943 </div>
944
945 <ul class="parameters">
946 <li>
947 <span class="var-type">string</span>
948 <span class="var-name">$email</span><span class="var-description">: <p>- the value to validate</p></span> </li>
949 </ul>
950
951
952 </div>
953 <a name="methodis_firstname" id="is_firstname"><!-- --></a>
954 <div class="evenrow">
955
956 <div class="method-header">
957 <span class="method-title">is_firstname</span> (line <span class="line-number">977</span>)
958 </div>
959
960 <!-- ========== Info from phpDoc block ========= -->
961 <p class="short-description">This is just a wrapper for</p>
962 <ul class="tags">
963 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
964 </ul>
965
966 <div class="method-signature">
967 <span class="method-result">TRUE</span>
968 <span class="method-name">
969 is_firstname
970 </span>
971 (<span class="var-type">string</span>&nbsp;<span class="var-name">$firstname</span>)
972 </div>
973
974 <ul class="parameters">
975 <li>
976 <span class="var-type">string</span>
977 <span class="var-name">$firstname</span><span class="var-description">: <p>- the value to validate</p></span> </li>
978 </ul>
979
980
981 </div>
982 <a name="methodis_float" id="is_float"><!-- --></a>
983 <div class="oddrow">
984
985 <div class="method-header">
986 <span class="method-title">is_float</span> (line <span class="line-number">514</span>)
987 </div>
988
989 <!-- ========== Info from phpDoc block ========= -->
990 <p class="short-description">This method validates a string as a valid float formatted number. x.xx</p>
991 <ul class="tags">
992 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
993 </ul>
994
995 <div class="method-signature">
996 <span class="method-result">TRUE</span>
997 <span class="method-name">
998 is_float
999 </span>
1000 (<span class="var-type">string</span>&nbsp;<span class="var-name">$number</span>)
1001 </div>
1002
1003 <ul class="parameters">
1004 <li>
1005 <span class="var-type">string</span>
1006 <span class="var-name">$number</span><span class="var-description">: <p>- the value to validate</p></span> </li>
1007 </ul>
1008
1009
1010 </div>
1011 <a name="methodis_higherzeronumber" id="is_higherzeronumber"><!-- --></a>
1012 <div class="evenrow">
1013
1014 <div class="method-header">
1015 <span class="method-title">is_higherzeronumber</span> (line <span class="line-number">562</span>)
1016 </div>
1017
1018 <!-- ========== Info from phpDoc block ========= -->
1019 <p class="short-description">This method validates a string as a number greater then 0.</p>
1020 <ul class="tags">
1021 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
1022 </ul>
1023
1024 <div class="method-signature">
1025 <span class="method-result">TRUE</span>
1026 <span class="method-name">
1027 is_higherzeronumber
1028 </span>
1029 (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
1030 </div>
1031
1032 <ul class="parameters">
1033 <li>
1034 <span class="var-type">string</span>
1035 <span class="var-name">$value</span><span class="var-description">: <p>- the value to validate</p></span> </li>
1036 </ul>
1037
1038
1039 </div>
1040 <a name="methodis_host" id="is_host"><!-- --></a>
1041 <div class="oddrow">
1042
1043 <div class="method-header">
1044 <span class="method-title">is_host</span> (line <span class="line-number">1158</span>)
1045 </div>
1046
1047 <!-- ========== Info from phpDoc block ========= -->
1048 <p class="short-description">no comment</p>
1049
1050 <div class="method-signature">
1051 <span class="method-result">void</span>
1052 <span class="method-name">
1053 is_host
1054 </span>
1055 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$host</span>)
1056 </div>
1057
1058
1059
1060 </div>
1061 <a name="methodis_hostemail" id="is_hostemail"><!-- --></a>
1062 <div class="evenrow">
1063
1064 <div class="method-header">
1065 <span class="method-title">is_hostemail</span> (line <span class="line-number">709</span>)
1066 </div>
1067
1068 <!-- ========== Info from phpDoc block ========= -->
1069 <p class="short-description">This method tests a string as a valid hostname value or a valid email string</p>
1070 <ul class="tags">
1071 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
1072 </ul>
1073
1074 <div class="method-signature">
1075 <span class="method-result">TRUE</span>
1076 <span class="method-name">
1077 is_hostemail
1078 </span>
1079 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
1080 </div>
1081
1082 <ul class="parameters">
1083 <li>
1084 <span class="var-type">string</span>
1085 <span class="var-name">$name</span><span class="var-description">: <p>- the value to validate</p></span> </li>
1086 </ul>
1087
1088
1089 </div>
1090 <a name="methodis_hostip" id="is_hostip"><!-- --></a>
1091 <div class="oddrow">
1092
1093 <div class="method-header">
1094 <span class="method-title">is_hostip</span> (line <span class="line-number">432</span>)
1095 </div>
1096
1097 <!-- ========== Info from phpDoc block ========= -->
1098 <p class="short-description">This method tries to validate a string as a valid IP address or a hostname</p>
1099 <ul class="tags">
1100 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
1101 </ul>
1102
1103 <div class="method-signature">
1104 <span class="method-result">TRUE</span>
1105 <span class="method-name">
1106 is_hostip
1107 </span>
1108 (<span class="var-type">string</span>&nbsp;<span class="var-name">$hostip</span>)
1109 </div>
1110
1111 <ul class="parameters">
1112 <li>
1113 <span class="var-type">string</span>
1114 <span class="var-name">$hostip</span><span class="var-description">: <p>- the value to validate</p></span> </li>
1115 </ul>
1116
1117
1118 </div>
1119 <a name="methodis_hostlist" id="is_hostlist"><!-- --></a>
1120 <div class="evenrow">
1121
1122 <div class="method-header">
1123 <span class="method-title">is_hostlist</span> (line <span class="line-number">1166</span>)
1124 </div>
1125
1126 <!-- ========== Info from phpDoc block ========= -->
1127 <p class="short-description">no comment</p>
1128
1129 <div class="method-signature">
1130 <span class="method-result">void</span>
1131 <span class="method-name">
1132 is_hostlist
1133 </span>
1134 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$hostlist</span>)
1135 </div>
1136
1137
1138
1139 </div>
1140 <a name="methodis_hostname" id="is_hostname"><!-- --></a>
1141 <div class="oddrow">
1142
1143 <div class="method-header">
1144 <span class="method-title">is_hostname</span> (line <span class="line-number">356</span>)
1145 </div>
1146
1147 <!-- ========== Info from phpDoc block ========= -->
1148 <p class="short-description">This is just a wrapper for is_domainname</p>
1149 <ul class="tags">
1150 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
1151 </ul>
1152
1153 <div class="method-signature">
1154 <span class="method-result">TRUE</span>
1155 <span class="method-name">
1156 is_hostname
1157 </span>
1158 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
1159 </div>
1160
1161 <ul class="parameters">
1162 <li>
1163 <span class="var-type">string</span>
1164 <span class="var-name">$name</span><span class="var-description">: <p>- the value to validate</p></span> </li>
1165 </ul>
1166
1167
1168 </div>
1169 <a name="methodis_ip" id="is_ip"><!-- --></a>
1170 <div class="evenrow">
1171
1172 <div class="method-header">
1173 <span class="method-title">is_ip</span> (line <span class="line-number">368</span>)
1174 </div>
1175
1176 <!-- ========== Info from phpDoc block ========= -->
1177 <p class="short-description">This validates a string as an IP address This should work with either IPv4 or IPv6</p>
1178 <ul class="tags">
1179 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
1180 </ul>
1181
1182 <div class="method-signature">
1183 <span class="method-result">TRUE</span>
1184 <span class="method-name">
1185 is_ip
1186 </span>
1187 (<span class="var-type">string</span>&nbsp;<span class="var-name">$ip</span>)
1188 </div>
1189
1190 <ul class="parameters">
1191 <li>
1192 <span class="var-type">string</span>
1193 <span class="var-name">$ip</span><span class="var-description">: <p>- the value to validate</p></span> </li>
1194 </ul>
1195
1196
1197 </div>
1198 <a name="methodis_lastname" id="is_lastname"><!-- --></a>
1199 <div class="oddrow">
1200
1201 <div class="method-header">
1202 <span class="method-title">is_lastname</span> (line <span class="line-number">988</span>)
1203 </div>
1204
1205 <!-- ========== Info from phpDoc block ========= -->
1206 <p class="short-description">This is just a wrapper for</p>
1207 <ul class="tags">
1208 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
1209 </ul>
1210
1211 <div class="method-signature">
1212 <span class="method-result">TRUE</span>
1213 <span class="method-name">
1214 is_lastname
1215 </span>
1216 (<span class="var-type">string</span>&nbsp;<span class="var-name">$lastname</span>)
1217 </div>
1218
1219 <ul class="parameters">
1220 <li>
1221 <span class="var-type">string</span>
1222 <span class="var-name">$lastname</span><span class="var-description">: <p>- the value to validate</p></span> </li>
1223 </ul>
1224
1225
1226 </div>
1227 <a name="methodis_leapyear" id="is_leapyear"><!-- --></a>
1228 <div class="evenrow">
1229
1230 <div class="method-header">
1231 <span class="method-title">is_leapyear</span> (line <span class="line-number">815</span>)
1232 </div>
1233
1234 <!-- ========== Info from phpDoc block ========= -->
1235 <p class="short-description">This method validates a string as a leap year.</p>
1236 <ul class="tags">
1237 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
1238 </ul>
1239
1240 <div class="method-signature">
1241 <span class="method-result">TRUE</span>
1242 <span class="method-name">
1243 is_leapyear
1244 </span>
1245 (<span class="var-type">string</span>&nbsp;<span class="var-name">$yyyy</span>)
1246 </div>
1247
1248 <ul class="parameters">
1249 <li>
1250 <span class="var-type">string</span>
1251 <span class="var-name">$yyyy</span><span class="var-description">: <p>- the value to validate</p></span> </li>
1252 </ul>
1253
1254
1255 </div>
1256 <a name="methodis_manyemails" id="is_manyemails"><!-- --></a>
1257 <div class="oddrow">
1258
1259 <div class="method-header">
1260 <span class="method-title">is_manyemails</span> (line <span class="line-number">794</span>)
1261 </div>
1262
1263 <!-- ========== Info from phpDoc block ========= -->
1264 <p class="short-description">This function tests a string that may contain many email addresses seperated by commas</p>
1265 <ul class="tags">
1266 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
1267 </ul>
1268
1269 <div class="method-signature">
1270 <span class="method-result">TRUE</span>
1271 <span class="method-name">
1272 is_manyemails
1273 </span>
1274 (<span class="var-type">string</span>&nbsp;<span class="var-name">$emails</span>)
1275 </div>
1276
1277 <ul class="parameters">
1278 <li>
1279 <span class="var-type">string</span>
1280 <span class="var-name">$emails</span><span class="var-description">: <p>- the value to validate</p></span> </li>
1281 </ul>
1282
1283
1284 </div>
1285 <a name="methodis_money" id="is_money"><!-- --></a>
1286 <div class="evenrow">
1287
1288 <div class="method-header">
1289 <span class="method-title">is_money</span> (line <span class="line-number">466</span>)
1290 </div>
1291
1292 <!-- ========== Info from phpDoc block ========= -->
1293 <p class="short-description">This method tests a string to make sure it is in a valid money format.</p>
1294 <p class="description"><p>either $x or $x.cents</p></p>
1295 <ul class="tags">
1296 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
1297 </ul>
1298
1299 <div class="method-signature">
1300 <span class="method-result">TRUE</span>
1301 <span class="method-name">
1302 is_money
1303 </span>
1304 (<span class="var-type">string</span>&nbsp;<span class="var-name">$money</span>)
1305 </div>
1306
1307 <ul class="parameters">
1308 <li>
1309 <span class="var-type">string</span>
1310 <span class="var-name">$money</span><span class="var-description">: <p>- the value to validate</p></span> </li>
1311 </ul>
1312
1313
1314 </div>
1315 <a name="methodis_name" id="is_name"><!-- --></a>
1316 <div class="oddrow">
1317
1318 <div class="method-header">
1319 <span class="method-title">is_name</span> (line <span class="line-number">612</span>)
1320 </div>
1321
1322 <!-- ========== Info from phpDoc block ========= -->
1323 <p class="short-description">This validates a string as a valid proper name.</p>
1324 <p class="description"><p>The string can't be longer then VALIDATE_MAXSIZE in length, and it can only contain letters and numbers</p></p>
1325 <ul class="tags">
1326 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
1327 </ul>
1328
1329 <div class="method-signature">
1330 <span class="method-result">TRUE</span>
1331 <span class="method-name">
1332 is_name
1333 </span>
1334 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
1335 </div>
1336
1337 <ul class="parameters">
1338 <li>
1339 <span class="var-type">string</span>
1340 <span class="var-name">$name</span><span class="var-description">: <p>- the value to validate</p></span> </li>
1341 </ul>
1342
1343
1344 </div>
1345 <a name="methodis_notempty" id="is_notempty"><!-- --></a>
1346 <div class="evenrow">
1347
1348 <div class="method-header">
1349 <span class="method-title">is_notempty</span> (line <span class="line-number">132</span>)
1350 </div>
1351
1352 <!-- ========== Info from phpDoc block ========= -->
1353 <p class="short-description">This function makes sure the data is not empty</p>
1354 <ul class="tags">
1355 <li><span class="field">return:</span> <p>= not empty</p></li>
1356 </ul>
1357
1358 <div class="method-signature">
1359 <span class="method-result">TRUE</span>
1360 <span class="method-name">
1361 is_notempty
1362 </span>
1363 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
1364 </div>
1365
1366 <ul class="parameters">
1367 <li>
1368 <span class="var-type">mixed</span>
1369 <span class="var-name">$value</span> </li>
1370 </ul>
1371
1372
1373 </div>
1374 <a name="methodis_num" id="is_num"><!-- --></a>
1375 <div class="oddrow">
1376
1377 <div class="method-header">
1378 <span class="method-title">is_num</span> (line <span class="line-number">186</span>)
1379 </div>
1380
1381 <!-- ========== Info from phpDoc block ========= -->
1382 <p class="short-description">This function checks if the given string contains numerical digit characters.</p>
1383 <p class="description"><p>It also checks for the allowed additional characters.</p></p>
1384 <ul class="tags">
1385 <li><span class="field">return:</span> <p>FALSE - if any other extraneous characters are found TRUE upon succes.</p></li>
1386 </ul>
1387
1388 <div class="method-signature">
1389 <span class="method-result">boolean</span>
1390 <span class="method-name">
1391 is_num
1392 </span>
1393 (<span class="var-type">string</span>&nbsp;<span class="var-name">$str</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$from</span> = <span class="var-default">""</span>])
1394 </div>
1395
1396 <ul class="parameters">
1397 <li>
1398 <span class="var-type">string</span>
1399 <span class="var-name">$str</span><span class="var-description">: <p>- the string to check</p></span> </li>
1400 <li>
1401 <span class="var-type">string</span>
1402 <span class="var-name">$from</span><span class="var-description">: <p>- list of individual characters to allow besides a-zA-Z</p></span> </li>
1403 </ul>
1404
1405
1406 </div>
1407 <a name="methodis_number" id="is_number"><!-- --></a>
1408 <div class="evenrow">
1409
1410 <div class="method-header">
1411 <span class="method-title">is_number</span> (line <span class="line-number">450</span>)
1412 </div>
1413
1414 <!-- ========== Info from phpDoc block ========= -->
1415 <p class="short-description">This tests a string to make sure it is a valid number.</p>
1416 <ul class="tags">
1417 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
1418 </ul>
1419
1420 <div class="method-signature">
1421 <span class="method-result">TRUE</span>
1422 <span class="method-name">
1423 is_number
1424 </span>
1425 (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
1426 </div>
1427
1428 <ul class="parameters">
1429 <li>
1430 <span class="var-type">string</span>
1431 <span class="var-name">$value</span><span class="var-description">: <p>- the value to validate</p></span> </li>
1432 </ul>
1433
1434
1435 </div>
1436 <a name="methodis_partial_domainname" id="is_partial_domainname"><!-- --></a>
1437 <div class="oddrow">
1438
1439 <div class="method-header">
1440 <span class="method-title">is_partial_domainname</span> (line <span class="line-number">330</span>)
1441 </div>
1442
1443 <!-- ========== Info from phpDoc block ========= -->
1444 <p class="short-description">This method validates a string for a valid partial hostname for a machine.</p>
1445 <ul class="tags">
1446 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
1447 </ul>
1448
1449 <div class="method-signature">
1450 <span class="method-result">TRUE</span>
1451 <span class="method-name">
1452 is_partial_domainname
1453 </span>
1454 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
1455 </div>
1456
1457 <ul class="parameters">
1458 <li>
1459 <span class="var-type">string</span>
1460 <span class="var-name">$name</span><span class="var-description">: <p>- the value to validate</p></span> </li>
1461 </ul>
1462
1463
1464 </div>
1465 <a name="methodis_partial_ip" id="is_partial_ip"><!-- --></a>
1466 <div class="evenrow">
1467
1468 <div class="method-header">
1469 <span class="method-title">is_partial_ip</span> (line <span class="line-number">403</span>)
1470 </div>
1471
1472 <!-- ========== Info from phpDoc block ========= -->
1473 <p class="short-description">This validates a string as a portion of an IP address.</p>
1474 <p class="description"><p>This should work with either IPv4 or IPv6</p></p>
1475 <ul class="tags">
1476 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
1477 </ul>
1478
1479 <div class="method-signature">
1480 <span class="method-result">TRUE</span>
1481 <span class="method-name">
1482 is_partial_ip
1483 </span>
1484 (<span class="var-type">string</span>&nbsp;<span class="var-name">$ip</span>)
1485 </div>
1486
1487 <ul class="parameters">
1488 <li>
1489 <span class="var-type">string</span>
1490 <span class="var-name">$ip</span><span class="var-description">: <p>- the value to validate</p></span> </li>
1491 </ul>
1492
1493
1494 </div>
1495 <a name="methodis_password" id="is_password"><!-- --></a>
1496 <div class="oddrow">
1497
1498 <div class="method-header">
1499 <span class="method-title">is_password</span> (line <span class="line-number">675</span>)
1500 </div>
1501
1502 <!-- ========== Info from phpDoc block ========= -->
1503 <p class="short-description">This tries to validate a string as a password It can't be empty and has to be less then VALIDATE_MAXSIZE characters in length</p>
1504 <p class="description"><p>NOTE: password is case sensitive, and spaces are ignored.</p></p>
1505 <ul class="tags">
1506 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
1507 </ul>
1508
1509 <div class="method-signature">
1510 <span class="method-result">TRUE</span>
1511 <span class="method-name">
1512 is_password
1513 </span>
1514 (<span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>)
1515 </div>
1516
1517 <ul class="parameters">
1518 <li>
1519 <span class="var-type">string</span>
1520 <span class="var-name">$password</span><span class="var-description">: <p>- the value to validate</p></span> </li>
1521 </ul>
1522
1523
1524 </div>
1525 <a name="methodis_path" id="is_path"><!-- --></a>
1526 <div class="evenrow">
1527
1528 <div class="method-header">
1529 <span class="method-title">is_path</span> (line <span class="line-number">579</span>)
1530 </div>
1531
1532 <!-- ========== Info from phpDoc block ========= -->
1533 <p class="short-description">This method validates a string as a path to a file.</p>
1534 <ul class="tags">
1535 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
1536 </ul>
1537
1538 <div class="method-signature">
1539 <span class="method-result">TRUE</span>
1540 <span class="method-name">
1541 is_path
1542 </span>
1543 (<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>)
1544 </div>
1545
1546 <ul class="parameters">
1547 <li>
1548 <span class="var-type">string</span>
1549 <span class="var-name">$path</span><span class="var-description">: <p>- the value to validate</p></span> </li>
1550 </ul>
1551
1552
1553 </div>
1554 <a name="methodis_price" id="is_price"><!-- --></a>
1555 <div class="oddrow">
1556
1557 <div class="method-header">
1558 <span class="method-title">is_price</span> (line <span class="line-number">492</span>)
1559 </div>
1560
1561 <!-- ========== Info from phpDoc block ========= -->
1562 <p class="short-description">This method tries to validate a string as a valid price. It can't be zero (a la free!)</p>
1563 <ul class="tags">
1564 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
1565 </ul>
1566
1567 <div class="method-signature">
1568 <span class="method-result">TRUE</span>
1569 <span class="method-name">
1570 is_price
1571 </span>
1572 (<span class="var-type">string</span>&nbsp;<span class="var-name">$price</span>)
1573 </div>
1574
1575 <ul class="parameters">
1576 <li>
1577 <span class="var-type">string</span>
1578 <span class="var-name">$price</span><span class="var-description">: <p>- the value to validate</p></span> </li>
1579 </ul>
1580
1581
1582 </div>
1583 <a name="methodis_range" id="is_range"><!-- --></a>
1584 <div class="evenrow">
1585
1586 <div class="method-header">
1587 <span class="method-title">is_range</span> (line <span class="line-number">218</span>)
1588 </div>
1589
1590 <!-- ========== Info from phpDoc block ========= -->
1591 <p class="short-description">is_range</p>
1592 <p class="description"><p>This is the range check that the can be used in checks_array. Valarray should be: array('val' =&gt; $val, 'size' =&gt; $size OPTIONAL 'min' =&gt; $min, 'max' =&gt; $max, )</p></p>
1593
1594 <div class="method-signature">
1595 <span class="method-result">void</span>
1596 <span class="method-name">
1597 is_range
1598 </span>
1599 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$size</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$min</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$max</span>)
1600 </div>
1601
1602
1603
1604 </div>
1605 <a name="methodis_standalone_hostname" id="is_standalone_hostname"><!-- --></a>
1606 <div class="oddrow">
1607
1608 <div class="method-header">
1609 <span class="method-title">is_standalone_hostname</span> (line <span class="line-number">280</span>)
1610 </div>
1611
1612 <!-- ========== Info from phpDoc block ========= -->
1613 <p class="short-description">this method tests to see if this is a valid hostname value minus the domain name portion.</p>
1614 <ul class="tags">
1615 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
1616 </ul>
1617
1618 <div class="method-signature">
1619 <span class="method-result">TRUE</span>
1620 <span class="method-name">
1621 is_standalone_hostname
1622 </span>
1623 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
1624 </div>
1625
1626 <ul class="parameters">
1627 <li>
1628 <span class="var-type">string</span>
1629 <span class="var-name">$name</span><span class="var-description">: <p>- the value to validate</p></span> </li>
1630 </ul>
1631
1632
1633 </div>
1634 <a name="methodis_strict_url" id="is_strict_url"><!-- --></a>
1635 <div class="evenrow">
1636
1637 <div class="method-header">
1638 <span class="method-title">is_strict_url</span> (line <span class="line-number">1105</span>)
1639 </div>
1640
1641 <!-- ========== Info from phpDoc block ========= -->
1642 <p class="short-description">This method validates a strict url.</p>
1643 <p class="description"><p>It is the same as is_url, except that it requires the prefix http://</p></p>
1644 <ul class="tags">
1645 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
1646 </ul>
1647
1648 <div class="method-signature">
1649 <span class="method-result">TRUE</span>
1650 <span class="method-name">
1651 is_strict_url
1652 </span>
1653 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
1654 </div>
1655
1656 <ul class="parameters">
1657 <li>
1658 <span class="var-type">string</span>
1659 <span class="var-name">$url</span><span class="var-description">: <p>- the value to validate</p></span> </li>
1660 </ul>
1661
1662
1663 </div>
1664 <a name="methodis_time" id="is_time"><!-- --></a>
1665 <div class="oddrow">
1666
1667 <div class="method-header">
1668 <span class="method-title">is_time</span> (line <span class="line-number">950</span>)
1669 </div>
1670
1671 <!-- ========== Info from phpDoc block ========= -->
1672 <p class="short-description">This validates an array of fields as a valid time of the day</p>
1673 <p class="description"><p>NOTE: array must contain array( &quot;hour&quot; =&gt; VALUE, &quot;minutes&quot; =&gt; VALUE, &quot;seconds&quot; =&gt; VALUE);</p></p>
1674 <ul class="tags">
1675 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
1676 </ul>
1677
1678 <div class="method-signature">
1679 <span class="method-result">TRUE</span>
1680 <span class="method-name">
1681 is_time
1682 </span>
1683 (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
1684 </div>
1685
1686 <ul class="parameters">
1687 <li>
1688 <span class="var-type">string</span>
1689 <span class="var-name">$value</span><span class="var-description">: <p>- the value to validate</p></span> </li>
1690 </ul>
1691
1692
1693 </div>
1694 <a name="methodis_title" id="is_title"><!-- --></a>
1695 <div class="evenrow">
1696
1697 <div class="method-header">
1698 <span class="method-title">is_title</span> (line <span class="line-number">1123</span>)
1699 </div>
1700
1701 <!-- ========== Info from phpDoc block ========= -->
1702 <p class="short-description">Validate if the string is a good candidate to become an Title</p>
1703 <ul class="tags">
1704 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
1705 </ul>
1706
1707 <div class="method-signature">
1708 <span class="method-result">TRUE</span>
1709 <span class="method-name">
1710 is_title
1711 </span>
1712 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
1713 </div>
1714
1715 <ul class="parameters">
1716 <li>
1717 <span class="var-type">string</span>
1718 <span class="var-name">$name</span><span class="var-description">: <p>- the value to validate</p></span> </li>
1719 </ul>
1720
1721
1722 </div>
1723 <a name="methodis_url" id="is_url"><!-- --></a>
1724 <div class="oddrow">
1725
1726 <div class="method-header">
1727 <span class="method-title">is_url</span> (line <span class="line-number">1066</span>)
1728 </div>
1729
1730 <!-- ========== Info from phpDoc block ========= -->
1731 <p class="short-description">This method validates a string as a valid url It inclues the prefix, hostname/ip, port number and path.</p>
1732 <p class="description"><p>NOTE: format is in [http://] hostip [:port number] [path]</p></p>
1733 <ul class="tags">
1734 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
1735 </ul>
1736
1737 <div class="method-signature">
1738 <span class="method-result">TRUE</span>
1739 <span class="method-name">
1740 is_url
1741 </span>
1742 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
1743 </div>
1744
1745 <ul class="parameters">
1746 <li>
1747 <span class="var-type">string</span>
1748 <span class="var-name">$url</span><span class="var-description">: <p>- the value to validate</p></span> </li>
1749 </ul>
1750
1751
1752 </div>
1753 <a name="methodis_urlpath" id="is_urlpath"><!-- --></a>
1754 <div class="evenrow">
1755
1756 <div class="method-header">
1757 <span class="method-title">is_urlpath</span> (line <span class="line-number">595</span>)
1758 </div>
1759
1760 <!-- ========== Info from phpDoc block ========= -->
1761 <p class="short-description">This method validates a string as a valid url path to a file</p>
1762 <ul class="tags">
1763 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
1764 </ul>
1765
1766 <div class="method-signature">
1767 <span class="method-result">TRUE</span>
1768 <span class="method-name">
1769 is_urlpath
1770 </span>
1771 (<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>)
1772 </div>
1773
1774 <ul class="parameters">
1775 <li>
1776 <span class="var-type">string</span>
1777 <span class="var-name">$path</span><span class="var-description">: <p>- the value to validate</p></span> </li>
1778 </ul>
1779
1780
1781 </div>
1782 <a name="methodis_username" id="is_username"><!-- --></a>
1783 <div class="oddrow">
1784
1785 <div class="method-header">
1786 <span class="method-title">is_username</span> (line <span class="line-number">649</span>)
1787 </div>
1788
1789 <!-- ========== Info from phpDoc block ========= -->
1790 <p class="short-description">This method tests to see if a string value</p>
1791 <p class="description"><p>is a valid 'account' name. The string can't be larger then VALIDATE_MAXSIZE, and can only contain alphanum characters</p></p>
1792 <ul class="tags">
1793 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
1794 </ul>
1795
1796 <div class="method-signature">
1797 <span class="method-result">TRUE</span>
1798 <span class="method-name">
1799 is_username
1800 </span>
1801 (<span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>)
1802 </div>
1803
1804 <ul class="parameters">
1805 <li>
1806 <span class="var-type">string</span>
1807 <span class="var-name">$username</span><span class="var-description">: <p>- the value to validate</p></span> </li>
1808 </ul>
1809
1810
1811 </div>
1812 <a name="methodis_valid_domain" id="is_valid_domain"><!-- --></a>
1813 <div class="evenrow">
1814
1815 <div class="method-header">
1816 <span class="method-title">is_valid_domain</span> (line <span class="line-number">1138</span>)
1817 </div>
1818
1819 <!-- ========== Info from phpDoc block ========= -->
1820 <p class="short-description">Validate domain Will check if a domain is valid</p>
1821 <ul class="tags">
1822 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
1823 </ul>
1824
1825 <div class="method-signature">
1826 <span class="method-result">TRUE</span>
1827 <span class="method-name">
1828 is_valid_domain
1829 </span>
1830 (<span class="var-type">string</span>&nbsp;<span class="var-name">$domain_value</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$allow_www</span> = <span class="var-default">false</span>])
1831 </div>
1832
1833 <ul class="parameters">
1834 <li>
1835 <span class="var-type">string</span>
1836 <span class="var-name">$domain_value</span><span class="var-description">: <p>- the value to validate</p></span> </li>
1837 </ul>
1838
1839
1840 </div>
1841 <a name="methodis_within_range" id="is_within_range"><!-- --></a>
1842 <div class="oddrow">
1843
1844 <div class="method-header">
1845 <span class="method-title">is_within_range</span> (line <span class="line-number">237</span>)
1846 </div>
1847
1848 <!-- ========== Info from phpDoc block ========= -->
1849 <p class="short-description">This method makes sure a value lies within a given range of values.</p>
1850 <p class="description"><p>The error message can be customized by passing in a customer error code</p></p>
1851 <ul class="tags">
1852 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
1853 </ul>
1854
1855 <div class="method-signature">
1856 <span class="method-result">TRUE</span>
1857 <span class="method-name">
1858 is_within_range
1859 </span>
1860 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$size</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$start</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$end</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$error</span> = <span class="var-default">FALSE</span>])
1861 </div>
1862
1863 <ul class="parameters">
1864 <li>
1865 <span class="var-type">mixed</span>
1866 <span class="var-name">$value</span><span class="var-description">: <p>- the value u want to check</p></span> </li>
1867 <li>
1868 <span class="var-type">int</span>
1869 <span class="var-name">$size</span><span class="var-description">: <p>- the size</p></span> </li>
1870 <li>
1871 <span class="var-type">mixed</span>
1872 <span class="var-name">$start</span><span class="var-description">: <p>- the lower bound value</p></span> </li>
1873 <li>
1874 <span class="var-type">mixed</span>
1875 <span class="var-name">$end</span><span class="var-description">: <p>- the upper bound value</p></span> </li>
1876 <li>
1877 <span class="var-type">string</span>
1878 <span class="var-name">$error</span><span class="var-description">: <p>- the error code if any</p></span> </li>
1879 </ul>
1880
1881
1882 </div>
1883 <a name="methodis_zero_onehundred" id="is_zero_onehundred"><!-- --></a>
1884 <div class="evenrow">
1885
1886 <div class="method-header">
1887 <span class="method-title">is_zero_onehundred</span> (line <span class="line-number">541</span>)
1888 </div>
1889
1890 <!-- ========== Info from phpDoc block ========= -->
1891 <p class="short-description">This validates a string as a valid number between 0 and 100</p>
1892 <ul class="tags">
1893 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
1894 </ul>
1895
1896 <div class="method-signature">
1897 <span class="method-result">TRUE</span>
1898 <span class="method-name">
1899 is_zero_onehundred
1900 </span>
1901 (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
1902 </div>
1903
1904 <ul class="parameters">
1905 <li>
1906 <span class="var-type">string</span>
1907 <span class="var-name">$value</span><span class="var-description">: <p>- the value to validate</p></span> </li>
1908 </ul>
1909
1910
1911 </div>
1912 <a name="methodis_zip" id="is_zip"><!-- --></a>
1913 <div class="oddrow">
1914
1915 <div class="method-header">
1916 <span class="method-title">is_zip</span> (line <span class="line-number">1001</span>)
1917 </div>
1918
1919 <!-- ========== Info from phpDoc block ========= -->
1920 <p class="short-description">This validates a string as a valid zipcode</p>
1921 <p class="description"><p>numbers, whitespace allowed</p></p>
1922 <ul class="tags">
1923 <li><span class="field">return:</span> <p>= succes FALSE = failed</p></li>
1924 </ul>
1925
1926 <div class="method-signature">
1927 <span class="method-result">TRUE</span>
1928 <span class="method-name">
1929 is_zip
1930 </span>
1931 (<span class="var-type">string</span>&nbsp;<span class="var-name">$zip</span>)
1932 </div>
1933
1934 <ul class="parameters">
1935 <li>
1936 <span class="var-type">string</span>
1937 <span class="var-name">$zip</span><span class="var-description">: <p>- the value to validate</p></span> </li>
1938 </ul>
1939
1940
1941 </div>
1942 <a name="method_error" id="_error"><!-- --></a>
1943 <div class="evenrow">
1944
1945 <div class="method-header">
1946 <span class="method-title">_error</span> (line <span class="line-number">90</span>)
1947 </div>
1948
1949 <!-- ========== Info from phpDoc block ========= -->
1950 <p class="short-description">A wrapper method to set the error message and error code before returning FALSE</p>
1951
1952 <div class="method-signature">
1953 <span class="method-result">FALSE</span>
1954 <span class="method-name">
1955 _error
1956 </span>
1957 (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$message</span> = <span class="var-default">NULL</span>])
1958 </div>
1959
1960 <ul class="parameters">
1961 <li>
1962 <span class="var-type">string</span>
1963 <span class="var-name">$code</span><span class="var-description">: <p>- error code</p></span> </li>
1964 </ul>
1965
1966
1967 </div>
1968
1969 </div>
1970 </div>
1971
1972 <p class="notes" id="credit">
1973 Documention generated on Thu, 31 Jul 2003 18:32:45 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
1974 </p>
1975 </div></body>
1976 </html>

MailToCvsAdmin">MailToCvsAdmin
ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed