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">
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";
15 function showNode(Node){
16 switch(navigator.family){
18 // Nav
4.x code fork...
19 var oTable = document.layers[
"span" + Node];
20 var oImg = document.layers[
"img" + Node];
23 // IE
4/
5 code fork...
24 var oTable = document.all[
"span" + Node];
25 var oImg = document.all[
"img" + Node];
28 // Standards Compliant code fork...
29 var oTable = document.getElementById(
"span" + Node);
30 var oImg = document.getElementById(
"img" + Node);
33 oImg.src = imgMinus.src;
34 oTable.style.display =
"block";
37 function hideNode(Node){
38 switch(navigator.family){
40 // Nav
4.x code fork...
41 var oTable = document.layers[
"span" + Node];
42 var oImg = document.layers[
"img" + Node];
45 // IE
4/
5 code fork...
46 var oTable = document.all[
"span" + Node];
47 var oImg = document.all[
"img" + Node];
50 // Standards Compliant code fork...
51 var oTable = document.getElementById(
"span" + Node);
52 var oImg = document.getElementById(
"img" + Node);
55 oImg.src = imgPlus.src;
56 oTable.style.display =
"none";
59 function nodeIsVisible(Node){
60 switch(navigator.family){
62 // Nav
4.x code fork...
63 var oTable = document.layers[
"span" + Node];
66 // IE
4/
5 code fork...
67 var oTable = document.all[
"span" + Node];
70 // Standards Compliant code fork...
71 var oTable = document.getElementById(
"span" + Node);
74 return (oTable && oTable.style.display ==
"block");
77 function toggleNodeVisibility(Node){
78 if (nodeIsVisible(Node)){
87 <div class=
"page-body">
88 <h2 class=
"class-name"><img src=
"../../media/images/Class_logo.png"
91 style=
"vertical-align: middle"> Validation
</h2>
93 <a name=
"sec-description"></a>
94 <div class=
"info-box">
95 <div class=
"info-box-title">Description
</div>
97 <span class=
"disabled">Description
</span> |
98 <a href=
"#sec-method-summary">Methods
</a> (
<a href=
"#sec-methods">details
</a>)
101 <div class=
"info-box-body">
102 <!-- ========== Info from phpDoc block ========= -->
103 <p class=
"short-description">Rules used for validation of form fields.
</p>
105 Located in
<a class=
"field" href=
"_Validation.php.html">/Validation.php
</a> (line
<span class=
"field">17</span>)
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>)
124 <div class=
"info-box-body">
125 <div class=
"method-summary">
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> <span class=
"var-name">$func_name
</span>)
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> <span class=
"var-name">$fieldname
</span>,
<span class=
"var-type">string
</span> <span class=
"var-name">$error_message
</span>,
<span class=
"var-type">string
</span> <span class=
"var-name">$function_name
</span>)
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> <span class=
"var-name">$field_string
</span>)
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> <span class=
"var-name">$field_string
</span>)
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> <span class=
"var-name">$field_string
</span>)
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> <span class=
"var-name">$prefix
</span> =
<span class=
"var-default">""</span>],
<span class=
"var-type">string
</span> <span class=
"var-name">$onsubmit
</span>)
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> <span class=
"var-name">$field_string
</span>,
<span class=
"var-type">string
</span> <span class=
"var-name">$select_string
</span>)
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> <span class=
"var-name">$object
</span>)
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> <span class=
"var-name">$field_string
</span>)
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> <span class=
"var-name">$field_string
</span>)
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>)
209 <div class=
"info-box-body">
210 <A NAME='method_detail'
></A>
211 <a name=
"methodValidation" id=
"Validation"><!-- --></a>
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>)
219 <!-- ========== Info from phpDoc block ========= -->
220 <p class=
"short-description">Initialise a new validation.
</p>
222 <div class=
"method-signature">
223 <span class=
"method-result">Validation
</span>
224 <span class=
"method-name">
227 (
<span class=
"var-type">string
</span> <span class=
"var-name">$func_name
</span>)
230 <ul class=
"parameters">
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>
238 <a name=
"methodAddRule" id=
"AddRule"><!-- --></a>
239 <div class=
"evenrow">
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>)
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>
250 <div class=
"method-signature">
251 <span class=
"method-result">void
</span>
252 <span class=
"method-name">
255 (
<span class=
"var-type">string
</span> <span class=
"var-name">$fieldname
</span>,
<span class=
"var-type">string
</span> <span class=
"var-name">$error_message
</span>,
<span class=
"var-type">string
</span> <span class=
"var-name">$function_name
</span>)
258 <ul class=
"parameters">
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>
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>
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>
272 <a name=
"methodnot_empty" id=
"not_empty"><!-- --></a>
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>)
280 <!-- ========== Info from phpDoc block ========= -->
281 <p class=
"short-description">Checks if a string is empty
</p>
283 <li><span class=
"field">return:
</span> True if the string is not empty.
</li>
286 <div class=
"method-signature">
287 <span class=
"method-result">boolean
</span>
288 <span class=
"method-name">
291 (
<span class=
"var-type">string
</span> <span class=
"var-name">$field_string
</span>)
294 <ul class=
"parameters">
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>
302 <a name=
"methodpositive_dollars" id=
"positive_dollars"><!-- --></a>
303 <div class=
"evenrow">
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>)
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>
314 <li><span class=
"field">return:
</span> Returns true if the given string is a positive dollar amount.
</li>
317 <div class=
"method-signature">
318 <span class=
"method-result">boolean
</span>
319 <span class=
"method-name">
322 (
<span class=
"var-type">string
</span> <span class=
"var-name">$field_string
</span>)
325 <ul class=
"parameters">
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>
333 <a name=
"methodpositive_integer" id=
"positive_integer"><!-- --></a>
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>)
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>
345 <li><span class=
"field">return:
</span> Returns true if the given string is a positive integer.
</li>
348 <div class=
"method-signature">
349 <span class=
"method-result">boolean
</span>
350 <span class=
"method-name">
353 (
<span class=
"var-type">string
</span> <span class=
"var-name">$field_string
</span>)
356 <ul class=
"parameters">
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>
364 <a name=
"methodRenderJavascript" id=
"RenderJavascript"><!-- --></a>
365 <div class=
"evenrow">
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>)
372 <!-- ========== Info from phpDoc block ========= -->
373 <p class=
"short-description">Returns the javascript for form validation using the rules.
</p>
375 <li><span class=
"field">return:
</span> HTML/Javascript for form validation.
</li>
378 <div class=
"method-signature">
379 <span class=
"method-result">string
</span>
380 <span class=
"method-name">
383 ([
<span class=
"var-type">string
</span> <span class=
"var-name">$prefix
</span> =
<span class=
"var-default">""</span>],
<span class=
"var-type">string
</span> <span class=
"var-name">$onsubmit
</span>)
386 <ul class=
"parameters">
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>
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>
397 <a name=
"methodselected" id=
"selected"><!-- --></a>
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>)
405 <!-- ========== Info from phpDoc block ========= -->
406 <p class=
"short-description">Checks that a string is not empty or zero
</p>
408 <li><span class=
"field">return:
</span> True if the string is not empty or equal to
0.
</li>
411 <div class=
"method-signature">
412 <span class=
"method-result">boolean
</span>
413 <span class=
"method-name">
416 (
<span class=
"var-type"></span> <span class=
"var-name">$field_string
</span>,
<span class=
"var-type">string
</span> <span class=
"var-name">$select_string
</span>)
419 <ul class=
"parameters">
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>
424 <span class=
"var-type"></span>
425 <span class=
"var-name">$field_string
</span> </li>
430 <a name=
"methodValidate" id=
"Validate"><!-- --></a>
431 <div class=
"evenrow">
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>)
438 <!-- ========== Info from phpDoc block ========= -->
439 <p class=
"short-description">Validates the form according to it's rules.
</p>
441 <li><span class=
"field">return:
</span> True if the validation succeeded.
</li>
444 <div class=
"method-signature">
445 <span class=
"method-result">boolean
</span>
446 <span class=
"method-name">
449 (
<span class=
"var-type">object
</span> <span class=
"var-name">$object
</span>)
452 <ul class=
"parameters">
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>
460 <a name=
"methodvalid_date_format" id=
"valid_date_format"><!-- --></a>
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>)
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>
472 <li><span class=
"field">return:
</span> Returns true if the given string matches the user's date format from session.
</li>
475 <div class=
"method-signature">
476 <span class=
"method-result">boolean
</span>
477 <span class=
"method-name">
480 (
<span class=
"var-type">string
</span> <span class=
"var-name">$field_string
</span>)
483 <ul class=
"parameters">
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>
491 <a name=
"methodvalid_email_format" id=
"valid_email_format"><!-- --></a>
492 <div class=
"evenrow">
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>)
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>
503 <li><span class=
"field">return:
</span> Returns true if the given string is a valid email address.
</li>
506 <div class=
"method-signature">
507 <span class=
"method-result">boolean
</span>
508 <span class=
"method-name">
511 (
<span class=
"var-type">string
</span> <span class=
"var-name">$field_string
</span>)
514 <ul class=
"parameters">
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>
527 <p class=
"notes" id=
"credit">
528 Documentation generated on Mon,
24 Oct
2011 20:
10:
15 +
1300 by
<a href=
"http://www.phpdoc.org" target=
"_blank">phpDocumentor
1.4.3</a>