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