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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.2 - (show annotations)
Thu May 6 16:26:20 2004 UTC (20 years, 3 months ago) by jonen
Branch: MAIN
CVS Tags: HEAD
Changes since 1.1: +887 -888 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 FormWizard</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 FormWizard</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_FormWizard_inc.html">/form/FormWizard.inc</a> (line <span class="field">26</span>)
34 </p>
35
36
37 <pre><a href="../../phpHtmlLib/Container.html">Container</a>
38 |
39 --<a href="../../phpHtmlLib/FormProcessing/FormProcessor.html">FormProcessor</a>
40 |
41 --FormWizard</pre>
42
43 </div>
44 </div>
45
46 <a name="sec-descendents"></a>
47 <div class="info-box">
48 <div class="info-box-title">Direct descendents</div>
49 <div class="nav-bar">
50 <a href="#sec-description">Description</a> |
51 <span class="disabled">Descendents</span>
52 | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
53 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
54
55 </div>
56 <div class="info-box-body">
57 <table cellpadding="2" cellspacing="0" class="class-table">
58 <tr>
59 <th class="class-table-header">Class</th>
60 <th class="class-table-header">Description</th>
61 </tr>
62 <tr>
63 <td style="padding-right: 2em"><a href="../../phpHtmlLib/form-examples/MyWizard.html">MyWizard</a></td>
64 <td>
65 This is the main engine for the processing
66 </td>
67 </tr>
68 </table>
69 </div>
70 </div>
71
72
73 <a name="sec-var-summary"></a>
74 <div class="info-box">
75 <div class="info-box-title">Variable Summary</span></div>
76 <div class="nav-bar">
77 <a href="#sec-description">Description</a> |
78 <a href="#sec-descendents">Descendents</a> |
79 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
80 |
81 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
82
83 </div>
84 <div class="info-box-body">
85 <div class="var-summary">
86 <div class="var-title">
87 <span class="var-type">mixed</span>
88 <a href="#$_steps" title="details" class="var-name">$_steps</a>
89 </div>
90 <div class="var-title">
91 <span class="var-type">mixed</span>
92 <a href="#$_vars" title="details" class="var-name">$_vars</a>
93 </div>
94 </div>
95 </div>
96 </div>
97
98 <a name="sec-method-summary"></a>
99 <div class="info-box">
100 <div class="info-box-title">Method Summary</span></div>
101 <div class="nav-bar">
102 <a href="#sec-description">Description</a> |
103 <a href="#sec-descendents">Descendents</a> |
104 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
105
106 |
107 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
108 </div>
109 <div class="info-box-body">
110 <div class="method-summary">
111
112 <div class="method-definition">
113 <span class="method-result">FormWizard</span>
114 <a href="#FormWizard" title="details" class="method-name">FormWizard</a>
115 ()
116 </div>
117
118 <div class="method-definition">
119 <span class="method-result">void</span>
120 <a href="#add_step" title="details" class="method-name">add_step</a>
121 (<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$desc</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$help</span>, <span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormContent.html">FormContent</a></span>&nbsp;<span class="var-name">&$step</span>)
122 </div>
123
124 <div class="method-definition">
125 <span class="method-result">void</span>
126 <a href="#render" title="details" class="method-name">render</a>
127 (<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>)
128 </div>
129
130 <div class="method-definition">
131 <span class="method-result">string</span>
132 <a href="#render_confirm" title="details" class="method-name">render_confirm</a>
133 (<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>)
134 </div>
135
136 <div class="method-definition">
137 <span class="method-result">void</span>
138 <a href="#user_setup" title="details" class="method-name">user_setup</a>
139 ()
140 </div>
141
142 <div class="method-definition">
143 <span class="method-result">string</span>
144 <a href="#_build_js" title="details" class="method-name">_build_js</a>
145 ()
146 </div>
147
148 <div class="method-definition">
149 <span class="method-result"><a href="../../phpHtmlLib/Atag.html">Atag</a></span>
150 <a href="#_build_step_image" title="details" class="method-name">&amp;_build_step_image</a>
151 (<span class="var-type">string</span>&nbsp;<span class="var-name">$step_num</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$step_title</span>)
152 </div>
153
154 <div class="method-definition">
155 <span class="method-result">void</span>
156 <a href="#_build_toolbar" title="details" class="method-name">_build_toolbar</a>
157 ()
158 </div>
159
160 <div class="method-definition">
161 <span class="method-result">void</span>
162 <a href="#_clean" title="details" class="method-name">_clean</a>
163 ()
164 </div>
165
166 <div class="method-definition">
167 <span class="method-result">void</span>
168 <a href="#_current_step" title="details" class="method-name">_current_step</a>
169 ()
170 </div>
171
172 <div class="method-definition">
173 <span class="method-result">void</span>
174 <a href="#_init" title="details" class="method-name">_init</a>
175 ()
176 </div>
177
178 <div class="method-definition">
179 <span class="method-result">void</span>
180 <a href="#_init_session" title="details" class="method-name">_init_session</a>
181 ()
182 </div>
183
184 <div class="method-definition">
185 <span class="method-result">boolean</span>
186 <a href="#_is_step_visited" title="details" class="method-name">_is_step_visited</a>
187 (<span class="var-type">int</span>&nbsp;<span class="var-name">$step_num</span>)
188 </div>
189
190 <div class="method-definition">
191 <span class="method-result">void</span>
192 <a href="#_process_form" title="details" class="method-name">_process_form</a>
193 ()
194 </div>
195
196 <div class="method-definition">
197 <span class="method-result">void</span>
198 <a href="#_session_test" title="details" class="method-name">_session_test</a>
199 ()
200 </div>
201
202 <div class="method-definition">
203 <span class="method-result">void</span>
204 <a href="#_set_current_step" title="details" class="method-name">_set_current_step</a>
205 (<span class="var-type">int</span>&nbsp;<span class="var-name">$step</span>)
206 </div>
207
208 <div class="method-definition">
209 <span class="method-result">void</span>
210 <a href="#_set_step" title="details" class="method-name">_set_step</a>
211 ()
212 </div>
213
214 <div class="method-definition">
215 <span class="method-result">void</span>
216 <a href="#_step_visited" title="details" class="method-name">_step_visited</a>
217 (<span class="var-type">int</span>&nbsp;<span class="var-name">$step_num</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$visited</span> = <span class="var-default">TRUE</span>])
218 </div>
219
220 <div class="method-definition">
221 <span class="method-result">void</span>
222 <a href="#__hidden_fields" title="details" class="method-name">__hidden_fields</a>
223 ()
224 </div>
225 </div>
226 </div>
227 </div>
228
229 <a name="sec-vars"></a>
230 <div class="info-box">
231 <div class="info-box-title">Variables</div>
232 <div class="nav-bar">
233 <a href="#sec-description">Description</a> |
234 <a href="#sec-descendents">Descendents</a> |
235 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
236
237
238 |
239 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
240
241 </div>
242 <div class="info-box-body">
243 <a name="var$_steps" id="$_steps"><!-- --></A>
244 <div class="evenrow">
245
246 <div class="var-header">
247 <span class="var-title">
248 <span class="var-type">mixed</span>
249 <span class="var-name">$_steps</span>
250 = <span class="var-default">array()</span> (line <span class="line-number">33</span>)
251 </span>
252 </div>
253
254 <!-- ========== Info from phpDoc block ========= -->
255 <p class="short-description">This holds the array of</p>
256 <p class="description"><p>step objects for the wizard</p></p>
257
258
259
260
261
262 </div>
263 <a name="var$_vars" id="$_vars"><!-- --></A>
264 <div class="oddrow">
265
266 <div class="var-header">
267 <span class="var-title">
268 <span class="var-type">mixed</span>
269 <span class="var-name">$_vars</span>
270 = <span class="var-default">array(&quot;to_step&quot; =&gt; 0,<br /> &quot;num_steps&quot; =&gt; 0,<br /> &quot;on_confirm&quot; =&gt; FALSE,<br /> WIZARD_ID =&gt; NULL )</span> (line <span class="line-number">40</span>)
271 </span>
272 </div>
273
274 <!-- ========== Info from phpDoc block ========= -->
275 <p class="short-description">Holds a bunch of state</p>
276 <p class="description"><p>variables</p></p>
277
278
279
280
281
282 </div>
283
284 <h4>Inherited Variables</h4>
285 <A NAME='inherited_vars'><!-- --></A>
286 <p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html">FormProcessor</a></span></p>
287 <blockquote>
288 <span class="var-title">
289 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#var$_auto_show_errors">FormProcessor::$_auto_show_errors</a></span><br>
290 </span>
291 <span class="var-title">
292 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#var$_confirmed">FormProcessor::$_confirmed</a></span><br>
293 </span>
294 <span class="var-title">
295 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#var$_confirmed_successfull">FormProcessor::$_confirmed_successfull</a></span><br>
296 </span>
297 <span class="var-title">
298 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#var$_FormValidation">FormProcessor::$_FormValidation</a></span><br>
299 </span>
300 <span class="var-title">
301 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#var$_form_attributes">FormProcessor::$_form_attributes</a></span><br>
302 </span>
303 <span class="var-title">
304 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#var$_form_content">FormProcessor::$_form_content</a></span><br>
305 </span>
306 <span class="var-title">
307 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#var$_form_submit_action">FormProcessor::$_form_submit_action</a></span><br>
308 </span>
309 <span class="var-title">
310 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#var$_form_success_render">FormProcessor::$_form_success_render</a></span><br>
311 </span>
312 <span class="var-title">
313 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#var$_has_errors">FormProcessor::$_has_errors</a></span><br>
314 </span>
315 </blockquote>
316
317 </div>
318 </div>
319
320 <a name="sec-methods"></a>
321 <div class="info-box">
322 <div class="info-box-title">Methods</div>
323 <div class="nav-bar">
324 <a href="#sec-description">Description</a> |
325 <a href="#sec-descendents">Descendents</a> |
326 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
327 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
328
329 </div>
330 <div class="info-box-body">
331 <A NAME='method_detail'></A>
332 <a name="methodFormWizard" id="FormWizard"><!-- --></a>
333 <div class="evenrow">
334
335 <div class="method-header">
336 <span class="method-title">Constructor FormWizard</span> (line <span class="line-number">49</span>)
337 </div>
338
339 <!-- ========== Info from phpDoc block ========= -->
340 <p class="short-description">The constructor</p>
341
342 <div class="method-signature">
343 <span class="method-result">FormWizard</span>
344 <span class="method-name">
345 FormWizard
346 </span>
347 ()
348 </div>
349
350
351
352 </div>
353 <a name="methodadd_step" id="add_step"><!-- --></a>
354 <div class="oddrow">
355
356 <div class="method-header">
357 <span class="method-title">add_step</span> (line <span class="line-number">275</span>)
358 </div>
359
360 <!-- ========== Info from phpDoc block ========= -->
361 <p class="short-description">This adds a step to the wizard</p>
362
363 <div class="method-signature">
364 <span class="method-result">void</span>
365 <span class="method-name">
366 add_step
367 </span>
368 (<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$desc</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$help</span>, <span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormContent.html">FormContent</a></span>&nbsp;<span class="var-name">&$step</span>)
369 </div>
370
371 <ul class="parameters">
372 <li>
373 <span class="var-type">string</span>
374 <span class="var-name">$title</span><span class="var-description">: - the title for the step</span> </li>
375 <li>
376 <span class="var-type">string</span>
377 <span class="var-name">$desc</span><span class="var-description">: - the description for the step</span> </li>
378 <li>
379 <span class="var-type">string</span>
380 <span class="var-name">$help</span><span class="var-description">: - the help url for the step (if any)</span> </li>
381 <li>
382 <span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormContent.html">FormContent</a></span>
383 <span class="var-name">&$step</span><span class="var-description">: - the form content object that is the step.</span> </li>
384 </ul>
385
386
387 </div>
388 <a name="methodrender" id="render"><!-- --></a>
389 <div class="evenrow">
390
391 <div class="method-header">
392 <span class="method-title">render</span> (line <span class="line-number">81</span>)
393 </div>
394
395 <!-- ========== Info from phpDoc block ========= -->
396 <p class="short-description">This function renders the</p>
397 <p class="description"><p>FormWizard</p></p>
398
399 <div class="method-signature">
400 <span class="method-result">void</span>
401 <span class="method-name">
402 render
403 </span>
404 (<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>)
405 </div>
406
407
408 <hr class="separator" />
409 <div class="notes">Redefinition of:</div>
410 <dl>
411 <dt><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodrender">FormProcessor::render()</a></dt>
412 <dd>This method is called to render the form's html</dd>
413 </dl>
414
415 </div>
416 <a name="methodrender_confirm" id="render_confirm"><!-- --></a>
417 <div class="oddrow">
418
419 <div class="method-header">
420 <span class="method-title">render_confirm</span> (line <span class="line-number">229</span>)
421 </div>
422
423 <!-- ========== Info from phpDoc block ========= -->
424 <p class="short-description">This function renders the confirmation page. This page sits in between the front end form, and the action handler.</p>
425 <p class="description"><p>This only gets called after a form and its data has been successfully validated.</p></p>
426 <ul class="tags">
427 <li><span class="field">return:</span> - the raw html</li>
428 </ul>
429
430 <div class="method-signature">
431 <span class="method-result">string</span>
432 <span class="method-name">
433 render_confirm
434 </span>
435 (<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>)
436 </div>
437
438 <ul class="parameters">
439 <li>
440 <span class="var-type">int</span>
441 <span class="var-name">$indent_level</span><span class="var-description">: - $indent_level</span> </li>
442 <li>
443 <span class="var-type">int</span>
444 <span class="var-name">$output_debug</span><span class="var-description">: - $output_debug</span> </li>
445 </ul>
446
447 <hr class="separator" />
448 <div class="notes">Redefinition of:</div>
449 <dl>
450 <dt><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodrender_confirm">FormProcessor::render_confirm()</a></dt>
451 <dd>This function renders the confirmation page. This page sits in between the front end form, and the action handler.</dd>
452 </dl>
453
454 </div>
455 <a name="methoduser_setup" id="user_setup"><!-- --></a>
456 <div class="evenrow">
457
458 <div class="method-header">
459 <span class="method-title">user_setup</span> (line <span class="line-number">259</span>)
460 </div>
461
462 <!-- ========== Info from phpDoc block ========= -->
463 <p class="short-description">A subclass can override this function to setup the class variables after the constructor. The constructor automatically calls this function.</p>
464
465 <div class="method-signature">
466 <span class="method-result">void</span>
467 <span class="method-name">
468 user_setup
469 </span>
470 ()
471 </div>
472
473
474
475 <hr class="separator" />
476 <div class="notes">Redefined in descendants as:</div>
477 <ul class="redefinitions">
478 <li>
479 <a href="../../phpHtmlLib/form-examples/MyWizard.html#methoduser_setup">MyWizard::user_setup()</a>
480 </li>
481 </ul>
482 </div>
483 <a name="method_build_js" id="_build_js"><!-- --></a>
484 <div class="oddrow">
485
486 <div class="method-header">
487 <span class="method-title">_build_js</span> (line <span class="line-number">368</span>)
488 </div>
489
490 <!-- ========== Info from phpDoc block ========= -->
491 <p class="short-description">This builds the javascript needed for the navigation of the wizard</p>
492
493 <div class="method-signature">
494 <span class="method-result">string</span>
495 <span class="method-name">
496 _build_js
497 </span>
498 ()
499 </div>
500
501
502
503 </div>
504 <a name="method_build_step_image" id="_build_step_image"><!-- --></a>
505 <div class="evenrow">
506
507 <div class="method-header">
508 <span class="method-title">_build_step_image</span> (line <span class="line-number">482</span>)
509 </div>
510
511 <!-- ========== Info from phpDoc block ========= -->
512 <p class="short-description">This function builds an image for a step #</p>
513 <ul class="tags">
514 <li><span class="field">return:</span> object</li>
515 </ul>
516
517 <div class="method-signature">
518 <span class="method-result"><a href="../../phpHtmlLib/Atag.html">Atag</a></span>
519 <span class="method-name">
520 &amp;_build_step_image
521 </span>
522 (<span class="var-type">string</span>&nbsp;<span class="var-name">$step_num</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$step_title</span>)
523 </div>
524
525 <ul class="parameters">
526 <li>
527 <span class="var-type">string</span>
528 <span class="var-name">$step_num</span><span class="var-description">: - the step # to build</span> </li>
529 </ul>
530
531
532 </div>
533 <a name="method_build_toolbar" id="_build_toolbar"><!-- --></a>
534 <div class="oddrow">
535
536 <div class="method-header">
537 <span class="method-title">_build_toolbar</span> (line <span class="line-number">398</span>)
538 </div>
539
540 <!-- ========== Info from phpDoc block ========= -->
541 <p class="short-description">This renders the toolbar/step table</p>
542 <p class="description"><p>for the navigation of the wizard</p></p>
543
544 <div class="method-signature">
545 <span class="method-result">void</span>
546 <span class="method-name">
547 _build_toolbar
548 </span>
549 ()
550 </div>
551
552
553
554 </div>
555 <a name="method_clean" id="_clean"><!-- --></a>
556 <div class="evenrow">
557
558 <div class="method-header">
559 <span class="method-title">_clean</span> (line <span class="line-number">586</span>)
560 </div>
561
562 <!-- ========== Info from phpDoc block ========= -->
563 <p class="short-description">This function cleans up the saved Session state for the wizard. This gets called when we have completed the wizard w/o errors.</p>
564
565 <div class="method-signature">
566 <span class="method-result">void</span>
567 <span class="method-name">
568 _clean
569 </span>
570 ()
571 </div>
572
573
574
575 </div>
576 <a name="method_current_step" id="_current_step"><!-- --></a>
577 <div class="oddrow">
578
579 <div class="method-header">
580 <span class="method-title">_current_step</span> (line <span class="line-number">540</span>)
581 </div>
582
583 <!-- ========== Info from phpDoc block ========= -->
584 <p class="short-description">This returns the current step id</p>
585 <p class="description"><p>from the session</p></p>
586
587 <div class="method-signature">
588 <span class="method-result">void</span>
589 <span class="method-name">
590 _current_step
591 </span>
592 ()
593 </div>
594
595
596
597 </div>
598 <a name="method_init" id="_init"><!-- --></a>
599 <div class="evenrow">
600
601 <div class="method-header">
602 <span class="method-title">_init</span> (line <span class="line-number">293</span>)
603 </div>
604
605 <!-- ========== Info from phpDoc block ========= -->
606 <p class="short-description">This function initializes all of the fields we need to keep track of for the internal state of the wizard. It also walks each of the step FormContent objects and initializes them.</p>
607 <p class="description"><p>We save some of the state of the wizard in the session.</p></p>
608
609 <div class="method-signature">
610 <span class="method-result">void</span>
611 <span class="method-name">
612 _init
613 </span>
614 ()
615 </div>
616
617
618
619 </div>
620 <a name="method_init_session" id="_init_session"><!-- --></a>
621 <div class="oddrow">
622
623 <div class="method-header">
624 <span class="method-title">_init_session</span> (line <span class="line-number">521</span>)
625 </div>
626
627 <!-- ========== Info from phpDoc block ========= -->
628 <p class="short-description">This method initializes the session</p>
629 <p class="description"><p>variable that we use</p></p>
630
631 <div class="method-signature">
632 <span class="method-result">void</span>
633 <span class="method-name">
634 _init_session
635 </span>
636 ()
637 </div>
638
639
640
641 </div>
642 <a name="method_is_step_visited" id="_is_step_visited"><!-- --></a>
643 <div class="evenrow">
644
645 <div class="method-header">
646 <span class="method-title">_is_step_visited</span> (line <span class="line-number">572</span>)
647 </div>
648
649 <!-- ========== Info from phpDoc block ========= -->
650 <p class="short-description">This tests to see if the step has been visited or not.</p>
651 <ul class="tags">
652 <li><span class="field">return:</span> - TRUE = visited</li>
653 </ul>
654
655 <div class="method-signature">
656 <span class="method-result">boolean</span>
657 <span class="method-name">
658 _is_step_visited
659 </span>
660 (<span class="var-type">int</span>&nbsp;<span class="var-name">$step_num</span>)
661 </div>
662
663 <ul class="parameters">
664 <li>
665 <span class="var-type">int</span>
666 <span class="var-name">$step_num</span><span class="var-description">: - the step to mark</span> </li>
667 </ul>
668
669
670 </div>
671 <a name="method_process_form" id="_process_form"><!-- --></a>
672 <div class="oddrow">
673
674 <div class="method-header">
675 <span class="method-title">_process_form</span> (line <span class="line-number">136</span>)
676 </div>
677
678 <!-- ========== Info from phpDoc block ========= -->
679 <p class="short-description">This method does the logic of</p>
680 <p class="description"><p>doing the form processing</p></p>
681
682 <div class="method-signature">
683 <span class="method-result">void</span>
684 <span class="method-name">
685 _process_form
686 </span>
687 ()
688 </div>
689
690
691 <hr class="separator" />
692 <div class="notes">Redefinition of:</div>
693 <dl>
694 <dt><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#method_process_form">FormProcessor::_process_form()</a></dt>
695 <dd>This method does the logic of</dd>
696 </dl>
697
698 </div>
699 <a name="method_session_test" id="_session_test"><!-- --></a>
700 <div class="evenrow">
701
702 <div class="method-header">
703 <span class="method-title">_session_test</span> (line <span class="line-number">594</span>)
704 </div>
705
706 <!-- ========== Info from phpDoc block ========= -->
707 <p class="short-description">This ensures that we have sessions started</p>
708
709 <div class="method-signature">
710 <span class="method-result">void</span>
711 <span class="method-name">
712 _session_test
713 </span>
714 ()
715 </div>
716
717
718
719 </div>
720 <a name="method_set_current_step" id="_set_current_step"><!-- --></a>
721 <div class="oddrow">
722
723 <div class="method-header">
724 <span class="method-title">_set_current_step</span> (line <span class="line-number">549</span>)
725 </div>
726
727 <!-- ========== Info from phpDoc block ========= -->
728 <p class="short-description">This sets the current step id</p>
729
730 <div class="method-signature">
731 <span class="method-result">void</span>
732 <span class="method-name">
733 _set_current_step
734 </span>
735 (<span class="var-type">int</span>&nbsp;<span class="var-name">$step</span>)
736 </div>
737
738 <ul class="parameters">
739 <li>
740 <span class="var-type">int</span>
741 <span class="var-name">$step</span><span class="var-description">: - the new step #</span> </li>
742 </ul>
743
744
745 </div>
746 <a name="method_set_step" id="_set_step"><!-- --></a>
747 <div class="evenrow">
748
749 <div class="method-header">
750 <span class="method-title">_set_step</span> (line <span class="line-number">329</span>)
751 </div>
752
753 <!-- ========== Info from phpDoc block ========= -->
754 <p class="short-description">This function sets the _form_content object for the current step we are operating on.</p>
755 <p class="description"><p>The parent FormProcessor needs this object set in order to process the step correctly.</p></p>
756
757 <div class="method-signature">
758 <span class="method-result">void</span>
759 <span class="method-name">
760 _set_step
761 </span>
762 ()
763 </div>
764
765
766
767 </div>
768 <a name="method_step_visited" id="_step_visited"><!-- --></a>
769 <div class="oddrow">
770
771 <div class="method-header">
772 <span class="method-title">_step_visited</span> (line <span class="line-number">562</span>)
773 </div>
774
775 <!-- ========== Info from phpDoc block ========= -->
776 <p class="short-description">This sets the state variable for the step to let us know it has been visited or not</p>
777
778 <div class="method-signature">
779 <span class="method-result">void</span>
780 <span class="method-name">
781 _step_visited
782 </span>
783 (<span class="var-type">int</span>&nbsp;<span class="var-name">$step_num</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$visited</span> = <span class="var-default">TRUE</span>])
784 </div>
785
786 <ul class="parameters">
787 <li>
788 <span class="var-type">int</span>
789 <span class="var-name">$step_num</span><span class="var-description">: - the step to mark</span> </li>
790 <li>
791 <span class="var-type">boolean</span>
792 <span class="var-name">$visited</span><span class="var-description">: - TRUE = visited</span> </li>
793 </ul>
794
795
796 </div>
797 <a name="method__hidden_fields" id="__hidden_fields"><!-- --></a>
798 <div class="evenrow">
799
800 <div class="method-header">
801 <span class="method-title">__hidden_fields</span> (line <span class="line-number">333</span>)
802 </div>
803
804 <!-- ========== Info from phpDoc block ========= -->
805
806 <div class="method-signature">
807 <span class="method-result">void</span>
808 <span class="method-name">
809 __hidden_fields
810 </span>
811 ()
812 </div>
813
814
815 <hr class="separator" />
816 <div class="notes">Redefinition of:</div>
817 <dl>
818 <dt><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#method__hidden_fields">FormProcessor::__hidden_fields()</a></dt>
819 <dd>This method adds the processor specific hidden fields.</dd>
820 </dl>
821
822 </div>
823 <h4>Inherited Methods</h4>
824 <a name='inherited_methods'><!-- --></a>
825 <!-- =========== Summary =========== -->
826 <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html">FormProcessor</a></span></p>
827 <blockquote>
828 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodFormProcessor">FormProcessor::FormProcessor()</a></span><br>
829 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodcan_validate">FormProcessor::can_validate()</a></span><br>
830 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methoddo_validation">FormProcessor::do_validation()</a></span><br>
831 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodget_action">FormProcessor::get_action()</a></span><br>
832 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodget_auto_error_display">FormProcessor::get_auto_error_display()</a></span><br>
833 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodget_error_array">FormProcessor::get_error_array()</a></span><br>
834 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodget_error_display_object">FormProcessor::get_error_display_object()</a></span><br>
835 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodget_form_action">FormProcessor::get_form_action()</a></span><br>
836 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodget_form_enctype">FormProcessor::get_form_enctype()</a></span><br>
837 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodget_form_method">FormProcessor::get_form_method()</a></span><br>
838 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodget_form_name">FormProcessor::get_form_name()</a></span><br>
839 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodget_form_target">FormProcessor::get_form_target()</a></span><br>
840 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodget_onsubmit">FormProcessor::get_onsubmit()</a></span><br>
841 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodhas_errors">FormProcessor::has_errors()</a></span><br>
842 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodis_action_successfull">FormProcessor::is_action_successfull()</a></span><br>
843 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodrender">FormProcessor::render()</a></span><br>
844 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodrender_confirm">FormProcessor::render_confirm()</a></span><br>
845 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodrender_error">FormProcessor::render_error()</a></span><br>
846 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodrender_form">FormProcessor::render_form()</a></span><br>
847 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodsetup_validation">FormProcessor::setup_validation()</a></span><br>
848 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodset_auto_error_display">FormProcessor::set_auto_error_display()</a></span><br>
849 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodset_form_action">FormProcessor::set_form_action()</a></span><br>
850 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodset_form_enctype">FormProcessor::set_form_enctype()</a></span><br>
851 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodset_form_method">FormProcessor::set_form_method()</a></span><br>
852 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodset_form_name">FormProcessor::set_form_name()</a></span><br>
853 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodset_form_target">FormProcessor::set_form_target()</a></span><br>
854 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodset_onsubmit">FormProcessor::set_onsubmit()</a></span><br>
855 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#methodset_render_form_after_success">FormProcessor::set_render_form_after_success()</a></span><br>
856 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#method_add_confirm_data">FormProcessor::_add_confirm_data()</a></span><br>
857 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#method_add_hidden_fields">FormProcessor::_add_hidden_fields()</a></span><br>
858 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#method_build_form_tag">FormProcessor::_build_form_tag()</a></span><br>
859 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#method_build_javascript">FormProcessor::_build_javascript()</a></span><br>
860 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#method_init_form_content">FormProcessor::_init_form_content()</a></span><br>
861 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#method_pre_confirm">FormProcessor::_pre_confirm()</a></span><br>
862 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#method_process_action">FormProcessor::_process_action()</a></span><br>
863 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#method_process_form">FormProcessor::_process_form()</a></span><br>
864 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#method_set_action">FormProcessor::_set_action()</a></span><br>
865 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#method_set_confirmed_success">FormProcessor::_set_confirmed_success()</a></span><br>
866 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormProcessor.html#method__hidden_fields">FormProcessor::__hidden_fields()</a></span><br>
867 </blockquote>
868 <!-- =========== Summary =========== -->
869 <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/Container.html">Container</a></span></p>
870 <blockquote>
871 <span class="method-name"><a href="../../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br>
872 <span class="method-name"><a href="../../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br>
873 <span class="method-name"><a href="../../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br>
874 <span class="method-name"><a href="../../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br>
875 <span class="method-name"><a href="../../phpHtmlLib/Container.html#methodget_element">Container::get_element()</a></span><br>
876 <span class="method-name"><a href="../../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br>
877 <span class="method-name"><a href="../../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br>
878 <span class="method-name"><a href="../../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br>
879 <span class="method-name"><a href="../../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br>
880 <span class="method-name"><a href="../../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br>
881 <span class="method-name"><a href="../../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br>
882 <span class="method-name"><a href="../../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br>
883 </blockquote>
884
885 </div>
886 </div>
887
888
889 <p class="notes" id="credit">
890 Documentation generated on Thu, 1 Apr 2004 09:38:55 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a>
891 </p>
892 </div></body>
893 </html>

MailToCvsAdmin">MailToCvsAdmin
ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed