/[cvs]/nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/FormProcessing/FormProcessor.html
ViewVC logotype

Contents of /nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/FormProcessing/FormProcessor.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.3 - (show annotations)
Thu May 6 16:26:18 2004 UTC (20 years, 3 months ago) by jonen
Branch: MAIN
CVS Tags: HEAD
Changes since 1.2: +1575 -1495 lines
File MIME type: text/html 
 updated all to v2.4.1 - Apr 01, 2004
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 FormProcessor</title>
7 <link rel="stylesheet" href="../../media/stylesheet.css" />
8 <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9 </head>
10 <body>
11 <div class="page-body">
12
13 <h2 class="class-name">Class FormProcessor</h2>
14
15 <a name="sec-description"></a>
16 <div class="info-box">
17 <div class="info-box-title">Description</div>
18 <div class="nav-bar">
19 <span class="disabled">Description</span> |
20 <a href="#sec-descendents">Descendents</a>
21 | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
22 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
23
24 </div>
25 <div class="info-box-body">
26 <!-- ========== Info from phpDoc block ========= -->
27 <p class="short-description">This is the main engine for the processing</p>
28 <p class="description"><p>of Forms. It builds the form tag, and calls the appropriate FormContent methods to build the FormElement's and validation, as well as backend processing to do the action after the data has been validated.</p></p>
29 <ul class="tags">
30 <li><span class="field">author:</span> Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</li>
31 </ul>
32 <p class="notes">
33 Located in <a class="field" href="_form_FormProcessor_inc.html">/form/FormProcessor.inc</a> (line <span class="field">31</span>)
34 </p>
35
36
37 <pre><a href="../../phpHtmlLib/Container.html">Container</a>
38 |
39 --FormProcessor</pre>
40
41 </div>
42 </div>
43
44 <a name="sec-descendents"></a>
45 <div class="info-box">
46 <div class="info-box-title">Direct descendents</div>
47 <div class="nav-bar">
48 <a href="#sec-description">Description</a> |
49 <span class="disabled">Descendents</span>
50 | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
51 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
52
53 </div>
54 <div class="info-box-body">
55 <table cellpadding="2" cellspacing="0" class="class-table">
56 <tr>
57 <th class="class-table-header">Class</th>
58 <th class="class-table-header">Description</th>
59 </tr>
60 <tr>
61 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FormWizard.html">FormWizard</a></td>
62 <td>
63 This is the main engine for the processing
64 </td>
65 </tr>
66 </table>
67 </div>
68 </div>
69
70
71 <a name="sec-var-summary"></a>
72 <div class="info-box">
73 <div class="info-box-title">Variable Summary</span></div>
74 <div class="nav-bar">
75 <a href="#sec-description">Description</a> |
76 <a href="#sec-descendents">Descendents</a> |
77 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
78 |
79 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
80
81 </div>
82 <div class="info-box-body">
83 <div class="var-summary">
84 <div class="var-title">
85 <span class="var-type">mixed</span>
86 <a href="#$_auto_show_errors" title="details" class="var-name">$_auto_show_errors</a>
87 </div>
88 <div class="var-title">
89 <span class="var-type">mixed</span>
90 <a href="#$_confirmed" title="details" class="var-name">$_confirmed</a>
91 </div>
92 <div class="var-title">
93 <span class="var-type">mixed</span>
94 <a href="#$_confirmed_successfull" title="details" class="var-name">$_confirmed_successfull</a>
95 </div>
96 <div class="var-title">
97 <span class="var-type">mixed</span>
98 <a href="#$_FormValidation" title="details" class="var-name">$_FormValidation</a>
99 </div>
100 <div class="var-title">
101 <span class="var-type">mixed</span>
102 <a href="#$_form_attributes" title="details" class="var-name">$_form_attributes</a>
103 </div>
104 <div class="var-title">
105 <span class="var-type">mixed</span>
106 <a href="#$_form_content" title="details" class="var-name">$_form_content</a>
107 </div>
108 <div class="var-title">
109 <span class="var-type">mixed</span>
110 <a href="#$_form_submit_action" title="details" class="var-name">$_form_submit_action</a>
111 </div>
112 <div class="var-title">
113 <span class="var-type">mixed</span>
114 <a href="#$_form_success_render" title="details" class="var-name">$_form_success_render</a>
115 </div>
116 <div class="var-title">
117 <span class="var-type">mixed</span>
118 <a href="#$_has_errors" title="details" class="var-name">$_has_errors</a>
119 </div>
120 </div>
121 </div>
122 </div>
123
124 <a name="sec-method-summary"></a>
125 <div class="info-box">
126 <div class="info-box-title">Method Summary</span></div>
127 <div class="nav-bar">
128 <a href="#sec-description">Description</a> |
129 <a href="#sec-descendents">Descendents</a> |
130 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
131
132 |
133 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
134 </div>
135 <div class="info-box-body">
136 <div class="method-summary">
137
138 <div class="method-definition">
139 <span class="method-result">FormProcessor</span>
140 <a href="#FormProcessor" title="details" class="method-name">FormProcessor</a>
141 (<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormContent.html">FormContent</a></span>&nbsp;<span class="var-name">&$form_content</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$form_name</span> = <span class="var-default">"myform"</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$form_action</span> = <span class="var-default">NULL</span>])
142 </div>
143
144 <div class="method-definition">
145 <span class="method-result">BOOLEAN</span>
146 <a href="#can_validate" title="details" class="method-name">can_validate</a>
147 ()
148 </div>
149
150 <div class="method-definition">
151 <span class="method-result">void</span>
152 <a href="#do_validation" title="details" class="method-name">do_validation</a>
153 ()
154 </div>
155
156 <div class="method-definition">
157 <span class="method-result">string</span>
158 <a href="#get_action" title="details" class="method-name">get_action</a>
159 ()
160 </div>
161
162 <div class="method-definition">
163 <span class="method-result">boolean</span>
164 <a href="#get_auto_error_display" title="details" class="method-name">get_auto_error_display</a>
165 ()
166 </div>
167
168 <div class="method-definition">
169 <span class="method-result">array</span>
170 <a href="#get_error_array" title="details" class="method-name">get_error_array</a>
171 ()
172 </div>
173
174 <div class="method-definition">
175 <span class="method-result">object</span>
176 <a href="#get_error_display_object" title="details" class="method-name">&amp;get_error_display_object</a>
177 ()
178 </div>
179
180 <div class="method-definition">
181 <span class="method-result">string</span>
182 <a href="#get_form_action" title="details" class="method-name">get_form_action</a>
183 ()
184 </div>
185
186 <div class="method-definition">
187 <span class="method-result">string</span>
188 <a href="#get_form_enctype" title="details" class="method-name">get_form_enctype</a>
189 ()
190 </div>
191
192 <div class="method-definition">
193 <span class="method-result">string</span>
194 <a href="#get_form_method" title="details" class="method-name">get_form_method</a>
195 ()
196 </div>
197
198 <div class="method-definition">
199 <span class="method-result">string</span>
200 <a href="#get_form_name" title="details" class="method-name">get_form_name</a>
201 ()
202 </div>
203
204 <div class="method-definition">
205 <span class="method-result">string</span>
206 <a href="#get_form_target" title="details" class="method-name">get_form_target</a>
207 ()
208 </div>
209
210 <div class="method-definition">
211 <span class="method-result">string</span>
212 <a href="#get_onsubmit" title="details" class="method-name">get_onsubmit</a>
213 ()
214 </div>
215
216 <div class="method-definition">
217 <span class="method-result">boolean</span>
218 <a href="#has_errors" title="details" class="method-name">has_errors</a>
219 ()
220 </div>
221
222 <div class="method-definition">
223 <span class="method-result">boolean</span>
224 <a href="#is_action_successfull" title="details" class="method-name">is_action_successfull</a>
225 ()
226 </div>
227
228 <div class="method-definition">
229 <span class="method-result">void</span>
230 <a href="#render" title="details" class="method-name">render</a>
231 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$indent_level</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$output_debug</span>)
232 </div>
233
234 <div class="method-definition">
235 <span class="method-result">string</span>
236 <a href="#render_confirm" title="details" class="method-name">render_confirm</a>
237 (<span class="var-type">int</span>&nbsp;<span class="var-name">$indent_level</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$output_debug</span>)
238 </div>
239
240 <div class="method-definition">
241 <span class="method-result">raw</span>
242 <a href="#render_error" title="details" class="method-name">render_error</a>
243 (<span class="var-type">array</span>&nbsp;<span class="var-name">$indent_level</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$output_debug</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">2</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">3</span>)
244 </div>
245
246 <div class="method-definition">
247 <span class="method-result">raw</span>
248 <a href="#render_form" title="details" class="method-name">render_form</a>
249 (<span class="var-type">the</span>&nbsp;<span class="var-name">$indent_level</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$output_debug</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$obj</span> = <span class="var-default">NULL</span>], <span class="var-type">object -</span>&nbsp;<span class="var-name">3</span>)
250 </div>
251
252 <div class="method-definition">
253 <span class="method-result">void</span>
254 <a href="#setup_validation" title="details" class="method-name">setup_validation</a>
255 ()
256 </div>
257
258 <div class="method-definition">
259 <span class="method-result">void</span>
260 <a href="#set_auto_error_display" title="details" class="method-name">set_auto_error_display</a>
261 ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">TRUE</span>])
262 </div>
263
264 <div class="method-definition">
265 <span class="method-result">void</span>
266 <a href="#set_form_action" title="details" class="method-name">set_form_action</a>
267 (<span class="var-type">string</span>&nbsp;<span class="var-name">$action</span>)
268 </div>
269
270 <div class="method-definition">
271 <span class="method-result">void</span>
272 <a href="#set_form_enctype" title="details" class="method-name">set_form_enctype</a>
273 (<span class="var-type">string</span>&nbsp;<span class="var-name">$enctype</span>)
274 </div>
275
276 <div class="method-definition">
277 <span class="method-result">void</span>
278 <a href="#set_form_method" title="details" class="method-name">set_form_method</a>
279 (<span class="var-type">string</span>&nbsp;<span class="var-name">$method</span>)
280 </div>
281
282 <div class="method-definition">
283 <span class="method-result">void</span>
284 <a href="#set_form_name" title="details" class="method-name">set_form_name</a>
285 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
286 </div>
287
288 <div class="method-definition">
289 <span class="method-result">void</span>
290 <a href="#set_form_target" title="details" class="method-name">set_form_target</a>
291 (<span class="var-type">string</span>&nbsp;<span class="var-name">$target</span>)
292 </div>
293
294 <div class="method-definition">
295 <span class="method-result">none</span>
296 <a href="#set_onsubmit" title="details" class="method-name">set_onsubmit</a>
297 (<span class="var-type">string</span>&nbsp;<span class="var-name">$js</span>)
298 </div>
299
300 <div class="method-definition">
301 <span class="method-result">void</span>
302 <a href="#set_render_form_after_success" title="details" class="method-name">set_render_form_after_success</a>
303 ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">TRUE</span>])
304 </div>
305
306 <div class="method-definition">
307 <span class="method-result">void</span>
308 <a href="#_add_confirm_data" title="details" class="method-name">_add_confirm_data</a>
309 ()
310 </div>
311
312 <div class="method-definition">
313 <span class="method-result">void</span>
314 <a href="#_add_hidden_fields" title="details" class="method-name">_add_hidden_fields</a>
315 ()
316 </div>
317
318 <div class="method-definition">
319 <span class="method-result"><a href="../../phpHtmlLib/FORMtag.html">FORMtag</a></span>
320 <a href="#_build_form_tag" title="details" class="method-name">_build_form_tag</a>
321 ()
322 </div>
323
324 <div class="method-definition">
325 <span class="method-result">string</span>
326 <a href="#_build_javascript" title="details" class="method-name">_build_javascript</a>
327 ()
328 </div>
329
330 <div class="method-definition">
331 <span class="method-result">none</span>
332 <a href="#_init_form_content" title="details" class="method-name">_init_form_content</a>
333 ()
334 </div>
335
336 <div class="method-definition">
337 <span class="method-result">void</span>
338 <a href="#_pre_confirm" title="details" class="method-name">_pre_confirm</a>
339 ()
340 </div>
341
342 <div class="method-definition">
343 <span class="method-result">void</span>
344 <a href="#_process_action" title="details" class="method-name">_process_action</a>
345 ()
346 </div>
347
348 <div class="method-definition">
349 <span class="method-result">void</span>
350 <a href="#_process_form" title="details" class="method-name">_process_form</a>
351 ()
352 </div>
353
354 <div class="method-definition">
355 <span class="method-result">void</span>
356 <a href="#_set_action" title="details" class="method-name">_set_action</a>
357 ()
358 </div>
359
360 <div class="method-definition">
361 <span class="method-result">void</span>
362 <a href="#_set_confirmed_success" title="details" class="method-name">_set_confirmed_success</a>
363 ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">TRUE</span>])
364 </div>
365
366 <div class="method-definition">
367 <span class="method-result">void</span>
368 <a href="#__hidden_fields" title="details" class="method-name">__hidden_fields</a>
369 ()
370 </div>
371 </div>
372 </div>
373 </div>
374
375 <a name="sec-vars"></a>
376 <div class="info-box">
377 <div class="info-box-title">Variables</div>
378 <div class="nav-bar">
379 <a href="#sec-description">Description</a> |
380 <a href="#sec-descendents">Descendents</a> |
381 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
382
383
384 |
385 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
386
387 </div>
388 <div class="info-box-body">
389 <a name="var$_auto_show_errors" id="$_auto_show_errors"><!-- --></A>
390 <div class="evenrow">
391
392 <div class="var-header">
393 <span class="var-title">
394 <span class="var-type">mixed</span>
395 <span class="var-name">$_auto_show_errors</span>
396 = <span class="var-default"> TRUE</span> (line <span class="line-number">99</span>)
397 </span>
398 </div>
399
400 <!-- ========== Info from phpDoc block ========= -->
401 <p class="short-description">This tells us to show or not to show the form errors autmatically.</p>
402 <p class="description"><p>The user of the FormProcessor may want to deal with errors manually</p></p>
403
404
405
406
407
408 </div>
409 <a name="var$_confirmed" id="$_confirmed"><!-- --></A>
410 <div class="oddrow">
411
412 <div class="var-header">
413 <span class="var-title">
414 <span class="var-type">mixed</span>
415 <span class="var-name">$_confirmed</span>
416 = <span class="var-default"> FALSE</span> (line <span class="line-number">65</span>)
417 </span>
418 </div>
419
420 <!-- ========== Info from phpDoc block ========= -->
421 <p class="short-description">Flag to let us know the form has been confirmed.</p>
422
423
424
425
426
427 </div>
428 <a name="var$_confirmed_successfull" id="$_confirmed_successfull"><!-- --></A>
429 <div class="evenrow">
430
431 <div class="var-header">
432 <span class="var-title">
433 <span class="var-type">mixed</span>
434 <span class="var-name">$_confirmed_successfull</span>
435 = <span class="var-default"> FALSE</span> (line <span class="line-number">91</span>)
436 </span>
437 </div>
438
439 <!-- ========== Info from phpDoc block ========= -->
440 <p class="short-description">The form was processed and passed</p>
441 <p class="description"><p>the confirmation if any, and it was successfull ?</p></p>
442
443
444
445
446
447 </div>
448 <a name="var$_FormValidation" id="$_FormValidation"><!-- --></A>
449 <div class="oddrow">
450
451 <div class="var-header">
452 <span class="var-title">
453 <span class="var-type">mixed</span>
454 <span class="var-name">$_FormValidation</span>
455 = <span class="var-default"> NULL</span> (line <span class="line-number">78</span>)
456 </span>
457 </div>
458
459 <!-- ========== Info from phpDoc block ========= -->
460 <p class="short-description">This is the FormValidation object</p>
461 <p class="description"><p>used to validate the form elements</p></p>
462
463
464
465
466
467 </div>
468 <a name="var$_form_attributes" id="$_form_attributes"><!-- --></A>
469 <div class="evenrow">
470
471 <div class="var-header">
472 <span class="var-title">
473 <span class="var-type">mixed</span>
474 <span class="var-name">$_form_attributes</span>
475 = <span class="var-default">array(&quot;method&quot; =&gt; &quot;post&quot;,<br /> &quot;action&quot; =&gt; &quot;&quot;,<br /> &quot;name&quot; =&gt; &quot;myform&quot;,<br /> &quot;target&quot; =&gt; &quot;&quot;,<br /> &quot;onsubmit&quot; =&gt; &quot;&quot;,<br /> &quot;style&quot; =&gt; &quot;margin: 0px 0px 0px 0px;&quot;)</span> (line <span class="line-number">39</span>)
476 </span>
477 </div>
478
479 <!-- ========== Info from phpDoc block ========= -->
480 <p class="short-description">This array holds the FORMtag</p>
481 <p class="description"><p>attributes for this form</p></p>
482
483
484
485
486
487 </div>
488 <a name="var$_form_content" id="$_form_content"><!-- --></A>
489 <div class="oddrow">
490
491 <div class="var-header">
492 <span class="var-title">
493 <span class="var-type">mixed</span>
494 <span class="var-name">$_form_content</span>
495 = <span class="var-default"> NULL</span> (line <span class="line-number">51</span>)
496 </span>
497 </div>
498
499 <!-- ========== Info from phpDoc block ========= -->
500 <p class="short-description">This holds the FormContent Object that knows how to render the form.</p>
501
502
503
504
505
506 </div>
507 <a name="var$_form_submit_action" id="$_form_submit_action"><!-- --></A>
508 <div class="evenrow">
509
510 <div class="var-header">
511 <span class="var-title">
512 <span class="var-type">mixed</span>
513 <span class="var-name">$_form_submit_action</span>
514 = <span class="var-default"> NULL</span> (line <span class="line-number">84</span>)
515 </span>
516 </div>
517
518 <!-- ========== Info from phpDoc block ========= -->
519 <p class="short-description">The action that was taken</p>
520 <p class="description"><p>for the form</p></p>
521
522
523
524
525
526 </div>
527 <a name="var$_form_success_render" id="$_form_success_render"><!-- --></A>
528 <div class="oddrow">
529
530 <div class="var-header">
531 <span class="var-title">
532 <span class="var-type">mixed</span>
533 <span class="var-name">$_form_success_render</span>
534 = <span class="var-default"> TRUE</span> (line <span class="line-number">72</span>)
535 </span>
536 </div>
537
538 <!-- ========== Info from phpDoc block ========= -->
539 <p class="short-description">Flag to let us know if we should</p>
540 <p class="description"><p>render the form after it was successfully processed</p></p>
541
542
543
544
545
546 </div>
547 <a name="var$_has_errors" id="$_has_errors"><!-- --></A>
548 <div class="evenrow">
549
550 <div class="var-header">
551 <span class="var-title">
552 <span class="var-type">mixed</span>
553 <span class="var-name">$_has_errors</span>
554 = <span class="var-default"> FALSE</span> (line <span class="line-number">59</span>)
555 </span>
556 </div>
557
558 <!-- ========== Info from phpDoc block ========= -->
559 <p class="short-description">This flag lets us know there were errors during processing or validating the form.</p>
560
561
562
563
564
565 </div>
566
567
568 </div>
569 </div>
570
571 <a name="sec-methods"></a>
572 <div class="info-box">
573 <div class="info-box-title">Methods</div>
574 <div class="nav-bar">
575 <a href="#sec-description">Description</a> |
576 <a href="#sec-descendents">Descendents</a> |
577 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
578 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
579
580 </div>
581 <div class="info-box-body">
582 <A NAME='method_detail'></A>
583 <a name="methodFormProcessor" id="FormProcessor"><!-- --></a>
584 <div class="oddrow">
585
586 <div class="method-header">
587 <span class="method-title">Constructor FormProcessor</span> (line <span class="line-number">108</span>)
588 </div>
589
590 <!-- ========== Info from phpDoc block ========= -->
591 <p class="short-description">The constructor for the FormProcessor</p>
592
593 <div class="method-signature">
594 <span class="method-result">FormProcessor</span>
595 <span class="method-name">
596 FormProcessor
597 </span>
598 (<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormContent.html">FormContent</a></span>&nbsp;<span class="var-name">&$form_content</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$form_name</span> = <span class="var-default">"myform"</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$form_action</span> = <span class="var-default">NULL</span>])
599 </div>
600
601 <ul class="parameters">
602 <li>
603 <span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormContent.html">FormContent</a></span>
604 <span class="var-name">&$form_content</span><span class="var-description">: object</span> </li>
605 <li>
606 <span class="var-type">string</span>
607 <span class="var-name">$form_name</span><span class="var-description">: the form name</span> </li>
608 </ul>
609
610
611 </div>
612 <a name="methodcan_validate" id="can_validate"><!-- --></a>
613 <div class="evenrow">
614
615 <div class="method-header">
616 <span class="method-title">can_validate</span> (line <span class="line-number">415</span>)
617 </div>
618
619 <!-- ========== Info from phpDoc block ========= -->
620 <p class="short-description">This method lets us turn on/off the ability to do validation for the form</p>
621
622 <div class="method-signature">
623 <span class="method-result">BOOLEAN</span>
624 <span class="method-name">
625 can_validate
626 </span>
627 ()
628 </div>
629
630
631
632 </div>
633 <a name="methoddo_validation" id="do_validation"><!-- --></a>
634 <div class="oddrow">
635
636 <div class="method-header">
637 <span class="method-title">do_validation</span> (line <span class="line-number">246</span>)
638 </div>
639
640 <!-- ========== Info from phpDoc block ========= -->
641 <p class="short-description">This method walks the FormContent's visible elements</p>
642 <p class="description"><p>and calls the validation function for the element</p></p>
643
644 <div class="method-signature">
645 <span class="method-result">void</span>
646 <span class="method-name">
647 do_validation
648 </span>
649 ()
650 </div>
651
652
653
654 </div>
655 <a name="methodget_action" id="get_action"><!-- --></a>
656 <div class="evenrow">
657
658 <div class="method-header">
659 <span class="method-title">get_action</span> (line <span class="line-number">641</span>)
660 </div>
661
662 <!-- ========== Info from phpDoc block ========= -->
663 <p class="short-description">This is used to get the action that was processed by the form</p>
664
665 <div class="method-signature">
666 <span class="method-result">string</span>
667 <span class="method-name">
668 get_action
669 </span>
670 ()
671 </div>
672
673
674
675 </div>
676 <a name="methodget_auto_error_display" id="get_auto_error_display"><!-- --></a>
677 <div class="oddrow">
678
679 <div class="method-header">
680 <span class="method-title">get_auto_error_display</span> (line <span class="line-number">472</span>)
681 </div>
682
683 <!-- ========== Info from phpDoc block ========= -->
684 <p class="short-description">This gets the current value of the flag that tells us to show form errors automatically or not.</p>
685
686 <div class="method-signature">
687 <span class="method-result">boolean</span>
688 <span class="method-name">
689 get_auto_error_display
690 </span>
691 ()
692 </div>
693
694
695
696 </div>
697 <a name="methodget_error_array" id="get_error_array"><!-- --></a>
698 <div class="evenrow">
699
700 <div class="method-header">
701 <span class="method-title">get_error_array</span> (line <span class="line-number">501</span>)
702 </div>
703
704 <!-- ========== Info from phpDoc block ========= -->
705 <p class="short-description">This method returns an array of errors that happened in the form.</p>
706
707 <div class="method-signature">
708 <span class="method-result">array</span>
709 <span class="method-name">
710 get_error_array
711 </span>
712 ()
713 </div>
714
715
716
717 </div>
718 <a name="methodget_error_display_object" id="get_error_display_object"><!-- --></a>
719 <div class="oddrow">
720
721 <div class="method-header">
722 <span class="method-title">get_error_display_object</span> (line <span class="line-number">486</span>)
723 </div>
724
725 <!-- ========== Info from phpDoc block ========= -->
726 <p class="short-description">This method allows us to get access to the errors display object that is generated by the form content. This is the display object that is meant to be rendered directly.</p>
727 <p class="description"><p>If there are no errors. we will return NULL</p></p>
728
729 <div class="method-signature">
730 <span class="method-result">object</span>
731 <span class="method-name">
732 &amp;get_error_display_object
733 </span>
734 ()
735 </div>
736
737
738
739 </div>
740 <a name="methodget_form_action" id="get_form_action"><!-- --></a>
741 <div class="evenrow">
742
743 <div class="method-header">
744 <span class="method-title">get_form_action</span> (line <span class="line-number">601</span>)
745 </div>
746
747 <!-- ========== Info from phpDoc block ========= -->
748 <p class="short-description">This function is used to get the form action</p>
749 <ul class="tags">
750 <li><span class="field">return:</span> (POST or GET)</li>
751 </ul>
752
753 <div class="method-signature">
754 <span class="method-result">string</span>
755 <span class="method-name">
756 get_form_action
757 </span>
758 ()
759 </div>
760
761
762
763 </div>
764 <a name="methodget_form_enctype" id="get_form_enctype"><!-- --></a>
765 <div class="oddrow">
766
767 <div class="method-header">
768 <span class="method-title">get_form_enctype</span> (line <span class="line-number">620</span>)
769 </div>
770
771 <!-- ========== Info from phpDoc block ========= -->
772 <p class="short-description">This function is used to get the form enctype value</p>
773
774 <div class="method-signature">
775 <span class="method-result">string</span>
776 <span class="method-name">
777 get_form_enctype
778 </span>
779 ()
780 </div>
781
782
783
784 </div>
785 <a name="methodget_form_method" id="get_form_method"><!-- --></a>
786 <div class="evenrow">
787
788 <div class="method-header">
789 <span class="method-title">get_form_method</span> (line <span class="line-number">582</span>)
790 </div>
791
792 <!-- ========== Info from phpDoc block ========= -->
793 <p class="short-description">This function is used to get the form method</p>
794 <ul class="tags">
795 <li><span class="field">return:</span> (POST or GET)</li>
796 </ul>
797
798 <div class="method-signature">
799 <span class="method-result">string</span>
800 <span class="method-name">
801 get_form_method
802 </span>
803 ()
804 </div>
805
806
807
808 </div>
809 <a name="methodget_form_name" id="get_form_name"><!-- --></a>
810 <div class="oddrow">
811
812 <div class="method-header">
813 <span class="method-title">get_form_name</span> (line <span class="line-number">538</span>)
814 </div>
815
816 <!-- ========== Info from phpDoc block ========= -->
817 <p class="short-description">This function is used to get the form name</p>
818
819 <div class="method-signature">
820 <span class="method-result">string</span>
821 <span class="method-name">
822 get_form_name
823 </span>
824 ()
825 </div>
826
827
828
829 </div>
830 <a name="methodget_form_target" id="get_form_target"><!-- --></a>
831 <div class="evenrow">
832
833 <div class="method-header">
834 <span class="method-title">get_form_target</span> (line <span class="line-number">558</span>)
835 </div>
836
837 <!-- ========== Info from phpDoc block ========= -->
838 <p class="short-description">This function is used to get the form target</p>
839
840 <div class="method-signature">
841 <span class="method-result">string</span>
842 <span class="method-name">
843 get_form_target
844 </span>
845 ()
846 </div>
847
848
849
850 </div>
851 <a name="methodget_onsubmit" id="get_onsubmit"><!-- --></a>
852 <div class="oddrow">
853
854 <div class="method-header">
855 <span class="method-title">get_onsubmit</span> (line <span class="line-number">665</span>)
856 </div>
857
858 <!-- ========== Info from phpDoc block ========= -->
859 <p class="short-description">Gets the current value of the form tag's onsubmit value</p>
860
861 <div class="method-signature">
862 <span class="method-result">string</span>
863 <span class="method-name">
864 get_onsubmit
865 </span>
866 ()
867 </div>
868
869
870
871 </div>
872 <a name="methodhas_errors" id="has_errors"><!-- --></a>
873 <div class="evenrow">
874
875 <div class="method-header">
876 <span class="method-title">has_errors</span> (line <span class="line-number">511</span>)
877 </div>
878
879 <!-- ========== Info from phpDoc block ========= -->
880 <p class="short-description">This returns the flag that tells us that the form has errors during processing</p>
881
882 <div class="method-signature">
883 <span class="method-result">boolean</span>
884 <span class="method-name">
885 has_errors
886 </span>
887 ()
888 </div>
889
890
891
892 </div>
893 <a name="methodis_action_successfull" id="is_action_successfull"><!-- --></a>
894 <div class="oddrow">
895
896 <div class="method-header">
897 <span class="method-title">is_action_successfull</span> (line <span class="line-number">439</span>)
898 </div>
899
900 <!-- ========== Info from phpDoc block ========= -->
901 <p class="short-description">This is used to test to see if the form action was processed succesfully.</p>
902 <p class="description"><p>This is usefull for external entities to determine if the form was processed, and it was successfull.</p></p>
903
904 <div class="method-signature">
905 <span class="method-result">boolean</span>
906 <span class="method-name">
907 is_action_successfull
908 </span>
909 ()
910 </div>
911
912
913
914 </div>
915 <a name="methodrender" id="render"><!-- --></a>
916 <div class="evenrow">
917
918 <div class="method-header">
919 <span class="method-title">render</span> (line <span class="line-number">261</span>)
920 </div>
921
922 <!-- ========== Info from phpDoc block ========= -->
923 <p class="short-description">This method is called to render the form's html</p>
924
925 <div class="method-signature">
926 <span class="method-result">void</span>
927 <span class="method-name">
928 render
929 </span>
930 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$indent_level</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$output_debug</span>)
931 </div>
932
933
934 <hr class="separator" />
935 <div class="notes">Redefinition of:</div>
936 <dl>
937 <dt><a href="../../phpHtmlLib/Container.html#methodrender">Container::render()</a></dt>
938 <dd>This function is compatible with the rest of the phpHtmllib API spec.</dd>
939 </dl>
940
941 <hr class="separator" />
942 <div class="notes">Redefined in descendants as:</div>
943 <ul class="redefinitions">
944 <li>
945 <a href="../../phpHtmlLib/FormProcessing/FormWizard.html#methodrender">FormWizard::render()</a>
946 : This function renders the
947 </li>
948 </ul>
949 </div>
950 <a name="methodrender_confirm" id="render_confirm"><!-- --></a>
951 <div class="oddrow">
952
953 <div class="method-header">
954 <span class="method-title">render_confirm</span> (line <span class="line-number">357</span>)
955 </div>
956
957 <!-- ========== Info from phpDoc block ========= -->
958 <p class="short-description">This function renders the confirmation page. This page sits in between the front end form, and the action handler.</p>
959 <p class="description"><p>This only gets called after a form and its data has been successfully validated.</p></p>
960 <ul class="tags">
961 <li><span class="field">return:</span> - the raw html</li>
962 </ul>
963
964 <div class="method-signature">
965 <span class="method-result">string</span>
966 <span class="method-name">
967 render_confirm
968 </span>
969 (<span class="var-type">int</span>&nbsp;<span class="var-name">$indent_level</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$output_debug</span>)
970 </div>
971
972 <ul class="parameters">
973 <li>
974 <span class="var-type">int</span>
975 <span class="var-name">$indent_level</span><span class="var-description">: - $indent_level</span> </li>
976 <li>
977 <span class="var-type">int</span>
978 <span class="var-name">$output_debug</span><span class="var-description">: - $output_debug</span> </li>
979 </ul>
980
981
982 <hr class="separator" />
983 <div class="notes">Redefined in descendants as:</div>
984 <ul class="redefinitions">
985 <li>
986 <a href="../../phpHtmlLib/FormProcessing/FormWizard.html#methodrender_confirm">FormWizard::render_confirm()</a>
987 : This function renders the confirmation page. This page sits in between the front end form, and the action handler.
988 </li>
989 </ul>
990 </div>
991 <a name="methodrender_error" id="render_error"><!-- --></a>
992 <div class="evenrow">
993
994 <div class="method-header">
995 <span class="method-title">render_error</span> (line <span class="line-number">386</span>)
996 </div>
997
998 <!-- ========== Info from phpDoc block ========= -->
999 <p class="short-description">This renders the error table and then the form with the fields</p>
1000 <ul class="tags">
1001 <li><span class="field">return:</span> html</li>
1002 </ul>
1003
1004 <div class="method-signature">
1005 <span class="method-result">raw</span>
1006 <span class="method-name">
1007 render_error
1008 </span>
1009 (<span class="var-type">array</span>&nbsp;<span class="var-name">$indent_level</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$output_debug</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">2</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">3</span>)
1010 </div>
1011
1012 <ul class="parameters">
1013 <li>
1014 <span class="var-type">int</span>
1015 <span class="var-name">2</span><span class="var-description">: - $indent_level</span> </li>
1016 <li>
1017 <span class="var-type">int</span>
1018 <span class="var-name">3</span><span class="var-description">: - $output_debug</span> </li>
1019 <li>
1020 <span class="var-type">array</span>
1021 <span class="var-name">$indent_level</span><span class="var-description">: - the form field vlues.</span> </li>
1022 <li>
1023 <span class="var-type">array</span>
1024 <span class="var-name">$output_debug</span><span class="var-description">: - array of errors.</span> </li>
1025 </ul>
1026
1027
1028 </div>
1029 <a name="methodrender_form" id="render_form"><!-- --></a>
1030 <div class="oddrow">
1031
1032 <div class="method-header">
1033 <span class="method-title">render_form</span> (line <span class="line-number">307</span>)
1034 </div>
1035
1036 <!-- ========== Info from phpDoc block ========= -->
1037 <p class="short-description">This renders the form</p>
1038 <ul class="tags">
1039 <li><span class="field">return:</span> html</li>
1040 </ul>
1041
1042 <div class="method-signature">
1043 <span class="method-result">raw</span>
1044 <span class="method-name">
1045 render_form
1046 </span>
1047 (<span class="var-type">the</span>&nbsp;<span class="var-name">$indent_level</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$output_debug</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$obj</span> = <span class="var-default">NULL</span>], <span class="var-type">object -</span>&nbsp;<span class="var-name">3</span>)
1048 </div>
1049
1050 <ul class="parameters">
1051 <li>
1052 <span class="var-type">object -</span>
1053 <span class="var-name">3</span><span class="var-description">: the form errors object.</span> </li>
1054 <li>
1055 <span class="var-type">the</span>
1056 <span class="var-name">$indent_level</span><span class="var-description">: FormContent-&gt;form() object</span> </li>
1057 <li>
1058 <span class="var-type">int</span>
1059 <span class="var-name">$output_debug</span><span class="var-description">: - $indent_level</span> </li>
1060 <li>
1061 <span class="var-type">int</span>
1062 <span class="var-name">$obj</span><span class="var-description">: - $output_debug</span> </li>
1063 </ul>
1064
1065
1066 </div>
1067 <a name="methodsetup_validation" id="setup_validation"><!-- --></a>
1068 <div class="evenrow">
1069
1070 <div class="method-header">
1071 <span class="method-title">setup_validation</span> (line <span class="line-number">140</span>)
1072 </div>
1073
1074 <!-- ========== Info from phpDoc block ========= -->
1075 <p class="short-description">This function is used to setup the validation object and the form errors object that is to be used by this form.</p>
1076 <p class="description"><p>You can override this method to use a different FormErrors object for localization.</p></p>
1077
1078 <div class="method-signature">
1079 <span class="method-result">void</span>
1080 <span class="method-name">
1081 setup_validation
1082 </span>
1083 ()
1084 </div>
1085
1086
1087
1088 </div>
1089 <a name="methodset_auto_error_display" id="set_auto_error_display"><!-- --></a>
1090 <div class="oddrow">
1091
1092 <div class="method-header">
1093 <span class="method-title">set_auto_error_display</span> (line <span class="line-number">461</span>)
1094 </div>
1095
1096 <!-- ========== Info from phpDoc block ========= -->
1097 <p class="short-description">This sets the flag that tells this class to automatically call the form contents form errors and display it or not</p>
1098
1099 <div class="method-signature">
1100 <span class="method-result">void</span>
1101 <span class="method-name">
1102 set_auto_error_display
1103 </span>
1104 ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">TRUE</span>])
1105 </div>
1106
1107 <ul class="parameters">
1108 <li>
1109 <span class="var-type">boolean</span>
1110 <span class="var-name">$flag</span><span class="var-description">: - show errors?</span> </li>
1111 </ul>
1112
1113
1114 </div>
1115 <a name="methodset_form_action" id="set_form_action"><!-- --></a>
1116 <div class="evenrow">
1117
1118 <div class="method-header">
1119 <span class="method-title">set_form_action</span> (line <span class="line-number">591</span>)
1120 </div>
1121
1122 <!-- ========== Info from phpDoc block ========= -->
1123 <p class="short-description">Sets the form action</p>
1124
1125 <div class="method-signature">
1126 <span class="method-result">void</span>
1127 <span class="method-name">
1128 set_form_action
1129 </span>
1130 (<span class="var-type">string</span>&nbsp;<span class="var-name">$action</span>)
1131 </div>
1132
1133 <ul class="parameters">
1134 <li>
1135 <span class="var-type">string</span>
1136 <span class="var-name">$action</span> </li>
1137 </ul>
1138
1139
1140 </div>
1141 <a name="methodset_form_enctype" id="set_form_enctype"><!-- --></a>
1142 <div class="oddrow">
1143
1144 <div class="method-header">
1145 <span class="method-title">set_form_enctype</span> (line <span class="line-number">610</span>)
1146 </div>
1147
1148 <!-- ========== Info from phpDoc block ========= -->
1149 <p class="short-description">Sets the form enctype</p>
1150
1151 <div class="method-signature">
1152 <span class="method-result">void</span>
1153 <span class="method-name">
1154 set_form_enctype
1155 </span>
1156 (<span class="var-type">string</span>&nbsp;<span class="var-name">$enctype</span>)
1157 </div>
1158
1159 <ul class="parameters">
1160 <li>
1161 <span class="var-type">string</span>
1162 <span class="var-name">$enctype</span> </li>
1163 </ul>
1164
1165
1166 </div>
1167 <a name="methodset_form_method" id="set_form_method"><!-- --></a>
1168 <div class="evenrow">
1169
1170 <div class="method-header">
1171 <span class="method-title">set_form_method</span> (line <span class="line-number">568</span>)
1172 </div>
1173
1174 <!-- ========== Info from phpDoc block ========= -->
1175 <p class="short-description">This function is used to set the form method</p>
1176
1177 <div class="method-signature">
1178 <span class="method-result">void</span>
1179 <span class="method-name">
1180 set_form_method
1181 </span>
1182 (<span class="var-type">string</span>&nbsp;<span class="var-name">$method</span>)
1183 </div>
1184
1185 <ul class="parameters">
1186 <li>
1187 <span class="var-type">string</span>
1188 <span class="var-name">$method</span><span class="var-description">: (POST or GET)</span> </li>
1189 </ul>
1190
1191
1192 </div>
1193 <a name="methodset_form_name" id="set_form_name"><!-- --></a>
1194 <div class="oddrow">
1195
1196 <div class="method-header">
1197 <span class="method-title">set_form_name</span> (line <span class="line-number">528</span>)
1198 </div>
1199
1200 <!-- ========== Info from phpDoc block ========= -->
1201 <p class="short-description">This function is used to set the form name</p>
1202
1203 <div class="method-signature">
1204 <span class="method-result">void</span>
1205 <span class="method-name">
1206 set_form_name
1207 </span>
1208 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
1209 </div>
1210
1211 <ul class="parameters">
1212 <li>
1213 <span class="var-type">string</span>
1214 <span class="var-name">$name</span> </li>
1215 </ul>
1216
1217
1218 </div>
1219 <a name="methodset_form_target" id="set_form_target"><!-- --></a>
1220 <div class="evenrow">
1221
1222 <div class="method-header">
1223 <span class="method-title">set_form_target</span> (line <span class="line-number">548</span>)
1224 </div>
1225
1226 <!-- ========== Info from phpDoc block ========= -->
1227 <p class="short-description">This function is used to set the form target</p>
1228
1229 <div class="method-signature">
1230 <span class="method-result">void</span>
1231 <span class="method-name">
1232 set_form_target
1233 </span>
1234 (<span class="var-type">string</span>&nbsp;<span class="var-name">$target</span>)
1235 </div>
1236
1237 <ul class="parameters">
1238 <li>
1239 <span class="var-type">string</span>
1240 <span class="var-name">$target</span> </li>
1241 </ul>
1242
1243
1244 </div>
1245 <a name="methodset_onsubmit" id="set_onsubmit"><!-- --></a>
1246 <div class="oddrow">
1247
1248 <div class="method-header">
1249 <span class="method-title">set_onsubmit</span> (line <span class="line-number">655</span>)
1250 </div>
1251
1252 <!-- ========== Info from phpDoc block ========= -->
1253 <p class="short-description">Set the onsubmit attribute to the form NOTE: The FormContent child can automatically set this value depending on the FormElement children it contains.</p>
1254
1255 <div class="method-signature">
1256 <span class="method-result">none</span>
1257 <span class="method-name">
1258 set_onsubmit
1259 </span>
1260 (<span class="var-type">string</span>&nbsp;<span class="var-name">$js</span>)
1261 </div>
1262
1263 <ul class="parameters">
1264 <li>
1265 <span class="var-type">string</span>
1266 <span class="var-name">$js</span> </li>
1267 </ul>
1268
1269
1270 </div>
1271 <a name="methodset_render_form_after_success" id="set_render_form_after_success"><!-- --></a>
1272 <div class="evenrow">
1273
1274 <div class="method-header">
1275 <span class="method-title">set_render_form_after_success</span> (line <span class="line-number">427</span>)
1276 </div>
1277
1278 <!-- ========== Info from phpDoc block ========= -->
1279 <p class="short-description">This function turns on the ability to</p>
1280 <p class="description"><p>render the form after the success of the action. Normally this feature is off</p></p>
1281
1282 <div class="method-signature">
1283 <span class="method-result">void</span>
1284 <span class="method-name">
1285 set_render_form_after_success
1286 </span>
1287 ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">TRUE</span>])
1288 </div>
1289
1290
1291
1292 </div>
1293 <a name="method_add_confirm_data" id="_add_confirm_data"><!-- --></a>
1294 <div class="oddrow">
1295
1296 <div class="method-header">
1297 <span class="method-title">_add_confirm_data</span> (line <span class="line-number">748</span>)
1298 </div>
1299
1300 <!-- ========== Info from phpDoc block ========= -->
1301 <p class="short-description">This adds all of the submitted data as</p>
1302 <p class="description"><p>hidden form fields</p></p>
1303
1304 <div class="method-signature">
1305 <span class="method-result">void</span>
1306 <span class="method-name">
1307 _add_confirm_data
1308 </span>
1309 ()
1310 </div>
1311
1312
1313
1314 </div>
1315 <a name="method_add_hidden_fields" id="_add_hidden_fields"><!-- --></a>
1316 <div class="evenrow">
1317
1318 <div class="method-header">
1319 <span class="method-title">_add_hidden_fields</span> (line <span class="line-number">767</span>)
1320 </div>
1321
1322 <!-- ========== Info from phpDoc block ========= -->
1323 <p class="short-description">This function adds the form content's</p>
1324 <p class="description"><p>hidden form fields to the form automatically</p></p>
1325
1326 <div class="method-signature">
1327 <span class="method-result">void</span>
1328 <span class="method-name">
1329 _add_hidden_fields
1330 </span>
1331 ()
1332 </div>
1333
1334
1335
1336 </div>
1337 <a name="method_build_form_tag" id="_build_form_tag"><!-- --></a>
1338 <div class="oddrow">
1339
1340 <div class="method-header">
1341 <span class="method-title">_build_form_tag</span> (line <span class="line-number">705</span>)
1342 </div>
1343
1344 <!-- ========== Info from phpDoc block ========= -->
1345 <p class="short-description">this function builds the FORMtag object and its attributes.</p>
1346 <ul class="tags">
1347 <li><span class="field">return:</span> object.</li>
1348 </ul>
1349
1350 <div class="method-signature">
1351 <span class="method-result"><a href="../../phpHtmlLib/FORMtag.html">FORMtag</a></span>
1352 <span class="method-name">
1353 _build_form_tag
1354 </span>
1355 ()
1356 </div>
1357
1358
1359
1360 </div>
1361 <a name="method_build_javascript" id="_build_javascript"><!-- --></a>
1362 <div class="evenrow">
1363
1364 <div class="method-header">
1365 <span class="method-title">_build_javascript</span> (line <span class="line-number">803</span>)
1366 </div>
1367
1368 <!-- ========== Info from phpDoc block ========= -->
1369 <p class="short-description">This method is used to build any Javascript that is used by the form and/or the form elements used in the form.</p>
1370
1371 <div class="method-signature">
1372 <span class="method-result">string</span>
1373 <span class="method-name">
1374 _build_javascript
1375 </span>
1376 ()
1377 </div>
1378
1379
1380
1381 </div>
1382 <a name="method_init_form_content" id="_init_form_content"><!-- --></a>
1383 <div class="oddrow">
1384
1385 <div class="method-header">
1386 <span class="method-title">_init_form_content</span> (line <span class="line-number">680</span>)
1387 </div>
1388
1389 <!-- ========== Info from phpDoc block ========= -->
1390 <p class="short-description">This method initializes the FormContent during processing.</p>
1391
1392 <div class="method-signature">
1393 <span class="method-result">none</span>
1394 <span class="method-name">
1395 _init_form_content
1396 </span>
1397 ()
1398 </div>
1399
1400
1401
1402 </div>
1403 <a name="method_pre_confirm" id="_pre_confirm"><!-- --></a>
1404 <div class="evenrow">
1405
1406 <div class="method-header">
1407 <span class="method-title">_pre_confirm</span> (line <span class="line-number">226</span>)
1408 </div>
1409
1410 <!-- ========== Info from phpDoc block ========= -->
1411 <p class="short-description">This method calls the FormContent</p>
1412 <p class="description"><p>to let it do any data munging before the confirmation page is rendered</p></p>
1413
1414 <div class="method-signature">
1415 <span class="method-result">void</span>
1416 <span class="method-name">
1417 _pre_confirm
1418 </span>
1419 ()
1420 </div>
1421
1422
1423
1424 </div>
1425 <a name="method_process_action" id="_process_action"><!-- --></a>
1426 <div class="oddrow">
1427
1428 <div class="method-header">
1429 <span class="method-title">_process_action</span> (line <span class="line-number">216</span>)
1430 </div>
1431
1432 <!-- ========== Info from phpDoc block ========= -->
1433 <p class="short-description">This function is responsible for processing the form action after validation, and form confirmation happens.</p>
1434
1435 <div class="method-signature">
1436 <span class="method-result">void</span>
1437 <span class="method-name">
1438 _process_action
1439 </span>
1440 ()
1441 </div>
1442
1443
1444
1445 </div>
1446 <a name="method_process_form" id="_process_form"><!-- --></a>
1447 <div class="evenrow">
1448
1449 <div class="method-header">
1450 <span class="method-title">_process_form</span> (line <span class="line-number">148</span>)
1451 </div>
1452
1453 <!-- ========== Info from phpDoc block ========= -->
1454 <p class="short-description">This method does the logic of</p>
1455 <p class="description"><p>doing the form processing</p></p>
1456
1457 <div class="method-signature">
1458 <span class="method-result">void</span>
1459 <span class="method-name">
1460 _process_form
1461 </span>
1462 ()
1463 </div>
1464
1465
1466
1467 <hr class="separator" />
1468 <div class="notes">Redefined in descendants as:</div>
1469 <ul class="redefinitions">
1470 <li>
1471 <a href="../../phpHtmlLib/FormProcessing/FormWizard.html#method_process_form">FormWizard::_process_form()</a>
1472 : This method does the logic of
1473 </li>
1474 </ul>
1475 </div>
1476 <a name="method_set_action" id="_set_action"><!-- --></a>
1477 <div class="oddrow">
1478
1479 <div class="method-header">
1480 <span class="method-title">_set_action</span> (line <span class="line-number">630</span>)
1481 </div>
1482
1483 <!-- ========== Info from phpDoc block ========= -->
1484 <p class="short-description">This is used to set the action</p>
1485 <p class="description"><p>submitted by the user</p></p>
1486
1487 <div class="method-signature">
1488 <span class="method-result">void</span>
1489 <span class="method-name">
1490 _set_action
1491 </span>
1492 ()
1493 </div>
1494
1495
1496
1497 </div>
1498 <a name="method_set_confirmed_success" id="_set_confirmed_success"><!-- --></a>
1499 <div class="evenrow">
1500
1501 <div class="method-header">
1502 <span class="method-title">_set_confirmed_success</span> (line <span class="line-number">450</span>)
1503 </div>
1504
1505 <!-- ========== Info from phpDoc block ========= -->
1506 <p class="short-description">This flag sets the flag that tells if we successfully confirmed the form, and processed the action</p>
1507
1508 <div class="method-signature">
1509 <span class="method-result">void</span>
1510 <span class="method-name">
1511 _set_confirmed_success
1512 </span>
1513 ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">TRUE</span>])
1514 </div>
1515
1516 <ul class="parameters">
1517 <li>
1518 <span class="var-type">boolean</span>
1519 <span class="var-name">$flag</span> </li>
1520 </ul>
1521
1522
1523 </div>
1524 <a name="method__hidden_fields" id="__hidden_fields"><!-- --></a>
1525 <div class="oddrow">
1526
1527 <div class="method-header">
1528 <span class="method-title">__hidden_fields</span> (line <span class="line-number">780</span>)
1529 </div>
1530
1531 <!-- ========== Info from phpDoc block ========= -->
1532 <p class="short-description">This method adds the processor specific hidden fields.</p>
1533
1534 <div class="method-signature">
1535 <span class="method-result">void</span>
1536 <span class="method-name">
1537 __hidden_fields
1538 </span>
1539 ()
1540 </div>
1541
1542
1543
1544 <hr class="separator" />
1545 <div class="notes">Redefined in descendants as:</div>
1546 <ul class="redefinitions">
1547 <li>
1548 <a href="../../phpHtmlLib/FormProcessing/FormWizard.html#method__hidden_fields">FormWizard::__hidden_fields()</a>
1549 </li>
1550 </ul>
1551 </div>
1552 <h4>Inherited Methods</h4>
1553 <a name='inherited_methods'><!-- --></a>
1554 <!-- =========== Summary =========== -->
1555 <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/Container.html">Container</a></span></p>
1556 <blockquote>
1557 <span class="method-name"><a href="../../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br>
1558 <span class="method-name"><a href="../../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br>
1559 <span class="method-name"><a href="../../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br>
1560 <span class="method-name"><a href="../../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br>
1561 <span class="method-name"><a href="../../phpHtmlLib/Container.html#methodget_element">Container::get_element()</a></span><br>
1562 <span class="method-name"><a href="../../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br>
1563 <span class="method-name"><a href="../../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br>
1564 <span class="method-name"><a href="../../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br>
1565 <span class="method-name"><a href="../../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br>
1566 <span class="method-name"><a href="../../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br>
1567 <span class="method-name"><a href="../../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br>
1568 <span class="method-name"><a href="../../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br>
1569 </blockquote>
1570
1571 </div>
1572 </div>
1573
1574
1575 <p class="notes" id="credit">
1576 Documentation generated on Thu, 1 Apr 2004 09:38:52 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a>
1577 </p>
1578 </div></body>
1579 </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed