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