?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
cleanup text-match
[awl.git] / docs / api / awl / Validation / Validation.html
blob5c6dce1f79009e4099b85d53e73e0394a457ea7a
1
2 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
3 <?xml version="1.0" encoding="iso-8859-1"?>
4 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5 <html xmlns="http://www.w3.org/1999/xhtml">
6 <head>
7 <!-- template designed by Marco Von Ballmoos -->
8 <title>Docs For Class Validation</title>
9 <link rel="stylesheet" href="../../media/stylesheet.css" />
10 <script src="../../media/lib/classTree.js"></script>
11 <script language="javascript" type="text/javascript">
12 var imgPlus = new Image();
13 var imgMinus = new Image();
14 imgPlus.src = "../../media/images/plus.png";
15 imgMinus.src = "../../media/images/minus.png";
16
17 function showNode(Node){
18 switch(navigator.family){
19 case 'nn4':
20 // Nav 4.x code fork...
21 var oTable = document.layers["span" + Node];
22 var oImg = document.layers["img" + Node];
23 break;
24 case 'ie4':
25 // IE 4/5 code fork...
26 var oTable = document.all["span" + Node];
27 var oImg = document.all["img" + Node];
28 break;
29 case 'gecko':
30 // Standards Compliant code fork...
31 var oTable = document.getElementById("span" + Node);
32 var oImg = document.getElementById("img" + Node);
33 break;
34 }
35 oImg.src = imgMinus.src;
36 oTable.style.display = "block";
37 }
38
39 function hideNode(Node){
40 switch(navigator.family){
41 case 'nn4':
42 // Nav 4.x code fork...
43 var oTable = document.layers["span" + Node];
44 var oImg = document.layers["img" + Node];
45 break;
46 case 'ie4':
47 // IE 4/5 code fork...
48 var oTable = document.all["span" + Node];
49 var oImg = document.all["img" + Node];
50 break;
51 case 'gecko':
52 // Standards Compliant code fork...
53 var oTable = document.getElementById("span" + Node);
54 var oImg = document.getElementById("img" + Node);
55 break;
56 }
57 oImg.src = imgPlus.src;
58 oTable.style.display = "none";
59 }
60
61 function nodeIsVisible(Node){
62 switch(navigator.family){
63 case 'nn4':
64 // Nav 4.x code fork...
65 var oTable = document.layers["span" + Node];
66 break;
67 case 'ie4':
68 // IE 4/5 code fork...
69 var oTable = document.all["span" + Node];
70 break;
71 case 'gecko':
72 // Standards Compliant code fork...
73 var oTable = document.getElementById("span" + Node);
74 break;
75 }
76 return (oTable && oTable.style.display == "block");
77 }
78
79 function toggleNodeVisibility(Node){
80 if (nodeIsVisible(Node)){
81 hideNode(Node);
82 }else{
83 showNode(Node);
84 }
85 }
86 </script>
87 </head>
88 <body>
89 <div class="page-body">
90 <h2 class="class-name"><img src="../../media/images/Class_logo.png"
91 alt=" Class"
92 title=" Class"
93 style="vertical-align: middle"> Validation</h2>
94
95 <a name="sec-description"></a>
96 <div class="info-box">
97 <div class="info-box-title">Description</div>
98 <div class="nav-bar">
99 <span class="disabled">Description</span> |
100 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
101
102 </div>
103 <div class="info-box-body">
104
105 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
106 <!-- ========== Info from phpDoc block ========= -->
107 <p class="short-description">Rules used for validation of form fields.</p>
108 <p class="notes">
109 Located in <a class="field" href="_Validation.php.html">/Validation.php</a> (line <span class="field">17</span>)
110 </p>
111
112
113 <pre></pre>
114
115 </div>
116 </div>
117
118
119
120
121 <a name="sec-method-summary"></a>
122 <div class="info-box">
123 <div class="info-box-title">Method Summary</span></div>
124 <div class="nav-bar">
125 <a href="#sec-description">Description</a> |
126 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
127 </div>
128 <div class="info-box-body">
129 <div class="method-summary">
130
131 <div class="method-definition">
132 <img src="../../media/images/Constructor.png" alt=" "/>
133 <span class="method-result">Validation</span>
134 <a href="#Validation" title="details" class="method-name">Validation</a>
135 (<span class="var-type">string</span>&nbsp;<span class="var-name">$func_name</span>)
136 </div>
137
138 <div class="method-definition">
139 <img src="../../media/images/Method.png" alt=" "/>
140 <span class="method-result">void</span>
141 <a href="#AddRule" title="details" class="method-name">AddRule</a>
142 (<span class="var-type">string</span>&nbsp;<span class="var-name">$fieldname</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$error_message</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$function_name</span>)
143 </div>
144
145 <div class="method-definition">
146 <img src="../../media/images/Method.png" alt=" "/>
147 <span class="method-result">boolean</span>
148 <a href="#not_empty" title="details" class="method-name">not_empty</a>
149 (<span class="var-type">string</span>&nbsp;<span class="var-name">$field_string</span>)
150 </div>
151
152 <div class="method-definition">
153 <img src="../../media/images/Method.png" alt=" "/>
154 <span class="method-result">boolean</span>
155 <a href="#positive_dollars" title="details" class="method-name">positive_dollars</a>
156 (<span class="var-type">string</span>&nbsp;<span class="var-name">$field_string</span>)
157 </div>
158
159 <div class="method-definition">
160 <img src="../../media/images/Method.png" alt=" "/>
161 <span class="method-result">boolean</span>
162 <a href="#positive_integer" title="details" class="method-name">positive_integer</a>
163 (<span class="var-type">string</span>&nbsp;<span class="var-name">$field_string</span>)
164 </div>
165
166 <div class="method-definition">
167 <img src="../../media/images/Method.png" alt=" "/>
168 <span class="method-result">string</span>
169 <a href="#RenderJavascript" title="details" class="method-name">RenderJavascript</a>
170 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">&quot;&quot;</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$onsubmit</span>)
171 </div>
172
173 <div class="method-definition">
174 <img src="../../media/images/Method.png" alt=" "/>
175 <span class="method-result">boolean</span>
176 <a href="#selected" title="details" class="method-name">selected</a>
177 (<span class="var-type"></span>&nbsp;<span class="var-name">$field_string</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$select_string</span>)
178 </div>
179
180 <div class="method-definition">
181 <img src="../../media/images/Method.png" alt=" "/>
182 <span class="method-result">boolean</span>
183 <a href="#Validate" title="details" class="method-name">Validate</a>
184 (<span class="var-type">object</span>&nbsp;<span class="var-name">$object</span>)
185 </div>
186
187 <div class="method-definition">
188 <img src="../../media/images/Method.png" alt=" "/>
189 <span class="method-result">boolean</span>
190 <a href="#valid_date_format" title="details" class="method-name">valid_date_format</a>
191 (<span class="var-type">string</span>&nbsp;<span class="var-name">$field_string</span>)
192 </div>
193
194 <div class="method-definition">
195 <img src="../../media/images/Method.png" alt=" "/>
196 <span class="method-result">boolean</span>
197 <a href="#valid_email_format" title="details" class="method-name">valid_email_format</a>
198 (<span class="var-type">string</span>&nbsp;<span class="var-name">$field_string</span>)
199 </div>
200 </div>
201 </div>
202 </div>
203
204
205 <a name="sec-methods"></a>
206 <div class="info-box">
207 <div class="info-box-title">Methods</div>
208 <div class="nav-bar">
209 <a href="#sec-description">Description</a> |
210 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
211
212 </div>
213 <div class="info-box-body">
214
215 Strict Standards: Only variables should be passed by reference in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712
216
217 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
218 <A NAME='method_detail'></A>
219 <a name="methodValidation" id="Validation"><!-- --></a>
220 <div class="oddrow">
221
222 <div class="method-header">
223 <img src="../../media/images/Constructor.png" />
224 <span class="method-title">Constructor Validation</span> (line <span class="line-number">40</span>)
225 </div>
226
227 <!-- ========== Info from phpDoc block ========= -->
228 <p class="short-description">Initialise a new validation.</p>
229
230 <div class="method-signature">
231 <span class="method-result">Validation</span>
232 <span class="method-name">
233 Validation
234 </span>
235 (<span class="var-type">string</span>&nbsp;<span class="var-name">$func_name</span>)
236 </div>
237
238 <ul class="parameters">
239 <li>
240 <span class="var-type">string</span>
241 <span class="var-name">$func_name</span><span class="var-description">: The javascript function name to call onsubmit of the form</span> </li>
242 </ul>
243
244
245 </div>
246 <a name="methodAddRule" id="AddRule"><!-- --></a>
247 <div class="evenrow">
248
249 <div class="method-header">
250 <img src="../../media/images/Method.png" />
251 <span class="method-title">AddRule</span> (line <span class="line-number">53</span>)
252 </div>
253
254 <!-- ========== Info from phpDoc block ========= -->
255 <p class="short-description">Adds a validation rule for a specific field upon submission of the form.</p>
256 <p class="description"><p>You must call RenderRules below RenderFields when outputing the page</p></p>
257
258 <div class="method-signature">
259 <span class="method-result">void</span>
260 <span class="method-name">
261 AddRule
262 </span>
263 (<span class="var-type">string</span>&nbsp;<span class="var-name">$fieldname</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$error_message</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$function_name</span>)
264 </div>
265
266 <ul class="parameters">
267 <li>
268 <span class="var-type">string</span>
269 <span class="var-name">$fieldname</span><span class="var-description">: The name of the field.</span> </li>
270 <li>
271 <span class="var-type">string</span>
272 <span class="var-name">$error_message</span><span class="var-description">: The message to display on unsuccessful validation.</span> </li>
273 <li>
274 <span class="var-type">string</span>
275 <span class="var-name">$function_name</span><span class="var-description">: The function to call to validate the field</span> </li>
276 </ul>
277
278
279 </div>
280 <a name="methodnot_empty" id="not_empty"><!-- --></a>
281 <div class="oddrow">
282
283 <div class="method-header">
284 <img src="../../media/images/Method.png" />
285 <span class="method-title">not_empty</span> (line <span class="line-number">129</span>)
286 </div>
287
288 <!-- ========== Info from phpDoc block ========= -->
289 <p class="short-description">Checks if a string is empty</p>
290 <ul class="tags">
291 <li><span class="field">return:</span> True if the string is not empty.</li>
292 </ul>
293
294 <div class="method-signature">
295 <span class="method-result">boolean</span>
296 <span class="method-name">
297 not_empty
298 </span>
299 (<span class="var-type">string</span>&nbsp;<span class="var-name">$field_string</span>)
300 </div>
301
302 <ul class="parameters">
303 <li>
304 <span class="var-type">string</span>
305 <span class="var-name">$field_string</span><span class="var-description">: The field value that is being checked.</span> </li>
306 </ul>
307
308
309 </div>
310 <a name="methodpositive_dollars" id="positive_dollars"><!-- --></a>
311 <div class="evenrow">
312
313 <div class="method-header">
314 <img src="../../media/images/Method.png" />
315 <span class="method-title">positive_dollars</span> (line <span class="line-number">150</span>)
316 </div>
317
318 <!-- ========== Info from phpDoc block ========= -->
319 <p class="short-description">Check that the given string is a positive dollar amount.</p>
320 <p class="description"><p>Use not_empty first if string is required.</p></p>
321 <ul class="tags">
322 <li><span class="field">return:</span> Returns true if the given string is a positive dollar amount.</li>
323 </ul>
324
325 <div class="method-signature">
326 <span class="method-result">boolean</span>
327 <span class="method-name">
328 positive_dollars
329 </span>
330 (<span class="var-type">string</span>&nbsp;<span class="var-name">$field_string</span>)
331 </div>
332
333 <ul class="parameters">
334 <li>
335 <span class="var-type">string</span>
336 <span class="var-name">$field_string</span><span class="var-description">: The amount to be checked.</span> </li>
337 </ul>
338
339
340 </div>
341 <a name="methodpositive_integer" id="positive_integer"><!-- --></a>
342 <div class="oddrow">
343
344 <div class="method-header">
345 <img src="../../media/images/Method.png" />
346 <span class="method-title">positive_integer</span> (line <span class="line-number">167</span>)
347 </div>
348
349 <!-- ========== Info from phpDoc block ========= -->
350 <p class="short-description">Check that the given string is a positive integer.</p>
351 <p class="description"><p>Use not_empty first if string is required.</p></p>
352 <ul class="tags">
353 <li><span class="field">return:</span> Returns true if the given string is a positive integer.</li>
354 </ul>
355
356 <div class="method-signature">
357 <span class="method-result">boolean</span>
358 <span class="method-name">
359 positive_integer
360 </span>
361 (<span class="var-type">string</span>&nbsp;<span class="var-name">$field_string</span>)
362 </div>
363
364 <ul class="parameters">
365 <li>
366 <span class="var-type">string</span>
367 <span class="var-name">$field_string</span><span class="var-description">: The amount to be checked.</span> </li>
368 </ul>
369
370
371 </div>
372 <a name="methodRenderJavascript" id="RenderJavascript"><!-- --></a>
373 <div class="evenrow">
374
375 <div class="method-header">
376 <img src="../../media/images/Method.png" />
377 <span class="method-title">RenderJavascript</span> (line <span class="line-number">64</span>)
378 </div>
379
380 <!-- ========== Info from phpDoc block ========= -->
381 <p class="short-description">Returns the javascript for form validation using the rules.</p>
382 <ul class="tags">
383 <li><span class="field">return:</span> HTML/Javascript for form validation.</li>
384 </ul>
385
386 <div class="method-signature">
387 <span class="method-result">string</span>
388 <span class="method-name">
389 RenderJavascript
390 </span>
391 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">&quot;&quot;</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$onsubmit</span>)
392 </div>
393
394 <ul class="parameters">
395 <li>
396 <span class="var-type">string</span>
397 <span class="var-name">$onsubmit</span><span class="var-description">: The name of the function called on submission of the form.</span> </li>
398 <li>
399 <span class="var-type">string</span>
400 <span class="var-name">$prefix</span><span class="var-description">: Optional prefix for form fields.</span> </li>
401 </ul>
402
403
404 </div>
405 <a name="methodselected" id="selected"><!-- --></a>
406 <div class="oddrow">
407
408 <div class="method-header">
409 <img src="../../media/images/Method.png" />
410 <span class="method-title">selected</span> (line <span class="line-number">139</span>)
411 </div>
412
413 <!-- ========== Info from phpDoc block ========= -->
414 <p class="short-description">Checks that a string is not empty or zero</p>
415 <ul class="tags">
416 <li><span class="field">return:</span> True if the string is not empty or equal to 0.</li>
417 </ul>
418
419 <div class="method-signature">
420 <span class="method-result">boolean</span>
421 <span class="method-name">
422 selected
423 </span>
424 (<span class="var-type"></span>&nbsp;<span class="var-name">$field_string</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$select_string</span>)
425 </div>
426
427 <ul class="parameters">
428 <li>
429 <span class="var-type">string</span>
430 <span class="var-name">$select_string</span><span class="var-description">: The select value that is being checked.</span> </li>
431 <li>
432 <span class="var-type"></span>
433 <span class="var-name">$field_string</span> </li>
434 </ul>
435
436
437 </div>
438 <a name="methodValidate" id="Validate"><!-- --></a>
439 <div class="evenrow">
440
441 <div class="method-header">
442 <img src="../../media/images/Method.png" />
443 <span class="method-title">Validate</span> (line <span class="line-number">99</span>)
444 </div>
445
446 <!-- ========== Info from phpDoc block ========= -->
447 <p class="short-description">Validates the form according to it's rules.</p>
448 <ul class="tags">
449 <li><span class="field">return:</span> True if the validation succeeded.</li>
450 </ul>
451
452 <div class="method-signature">
453 <span class="method-result">boolean</span>
454 <span class="method-name">
455 Validate
456 </span>
457 (<span class="var-type">object</span>&nbsp;<span class="var-name">$object</span>)
458 </div>
459
460 <ul class="parameters">
461 <li>
462 <span class="var-type">object</span>
463 <span class="var-name">$object</span><span class="var-description">: The data object that requires form validation.</span> </li>
464 </ul>
465
466
467 </div>
468 <a name="methodvalid_date_format" id="valid_date_format"><!-- --></a>
469 <div class="oddrow">
470
471 <div class="method-header">
472 <img src="../../media/images/Method.png" />
473 <span class="method-title">valid_date_format</span> (line <span class="line-number">193</span>)
474 </div>
475
476 <!-- ========== Info from phpDoc block ========= -->
477 <p class="short-description">Check that the given string matches the user's date format.</p>
478 <p class="description"><p>Use not_empty first if string is required.</p></p>
479 <ul class="tags">
480 <li><span class="field">return:</span> Returns true if the given string matches the user's date format from session.</li>
481 </ul>
482
483 <div class="method-signature">
484 <span class="method-result">boolean</span>
485 <span class="method-name">
486 valid_date_format
487 </span>
488 (<span class="var-type">string</span>&nbsp;<span class="var-name">$field_string</span>)
489 </div>
490
491 <ul class="parameters">
492 <li>
493 <span class="var-type">string</span>
494 <span class="var-name">$field_string</span><span class="var-description">: The string to be checked.</span> </li>
495 </ul>
496
497
498 </div>
499 <a name="methodvalid_email_format" id="valid_email_format"><!-- --></a>
500 <div class="evenrow">
501
502 <div class="method-header">
503 <img src="../../media/images/Method.png" />
504 <span class="method-title">valid_email_format</span> (line <span class="line-number">179</span>)
505 </div>
506
507 <!-- ========== Info from phpDoc block ========= -->
508 <p class="short-description">Check that the given string is a valid email address.</p>
509 <p class="description"><p>Use not_empty first if string is required.</p></p>
510 <ul class="tags">
511 <li><span class="field">return:</span> Returns true if the given string is a valid email address.</li>
512 </ul>
513
514 <div class="method-signature">
515 <span class="method-result">boolean</span>
516 <span class="method-name">
517 valid_email_format
518 </span>
519 (<span class="var-type">string</span>&nbsp;<span class="var-name">$field_string</span>)
520 </div>
521
522 <ul class="parameters">
523 <li>
524 <span class="var-type">string</span>
525 <span class="var-name">$field_string</span><span class="var-description">: The string to be checked.</span> </li>
526 </ul>
527
528
529 </div>
530
531 </div>
532 </div>
533
534
535
536 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
537 <p class="notes" id="credit">
538 Documentation generated on Wed, 04 Jul 2012 07:06:16 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
539 </p>
540 </div></body>
541 </html>
Andrew's Web Libraries