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