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

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

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

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