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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1 - (hide annotations)
Wed Sep 24 13:11:47 2003 UTC (20 years, 11 months ago) by jonen
Branch: MAIN
File MIME type: text/html
+ updated whole phphtmllib to v2.3.0

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

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