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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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