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