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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (hide annotations)
Sat Feb 22 21:05:35 2003 UTC (21 years, 6 months ago) by jonen
Branch: MAIN
File MIME type: text/html 
+ updated whole lib to version 2.2.1 (new FormProcessing since 2.2.0!)
1 jonen 1.1 <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'>
2     <!--NewPage-->
3     <HTML>
4     <HEAD>
5     <!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:22:54 -0800' -->
6     <TITLE>Docs For Class FormProcessor</TITLE>
7     <LINK REL ='stylesheet' TYPE='text/css' HREF='../../media/stylesheet.css' TITLE='Style'>
8     </HEAD>
9     <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">
10     <!-- Links -->
11     <a NAME="top"></A>
12     <table WIDTH="100%" class="links">
13     <TR>
14     <TD class="font10">
15     Links:
16     <A HREF="#children_summary" class="links" title="Classes extended from FormProcessor">Child Classes</A>
17     <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>
18     <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>
19     <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inherited Methods</A>
20     <A HREF="#method_summary" class="links" title="Method Summary">Methods</A>
21     <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>
22     <A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A>
23     </TD>
24     </TR>
25     </TABLE>
26     <BR>
27     <!-- Start of Class Data -->
28     <H2>
29     Class FormProcessor
30     </H2> (line <span class="linenumber">31</span>)
31     <pre>
32     <a href="../../phpHtmlLib/Container.html">Container</a>
33     |
34     --FormProcessor</pre>
35     <p>
36     <b><i>Located in File: Program_Root/form/FormProcessor.inc</i></b><br>
37     </p>
38     <hr>
39     This is the main engine for the processing
40     <br />
41     <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>
42     <UL>
43     <LI><b>author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</CODE></LI>
44     </UL>
45     <hr>
46     <!-- =========== VAR SUMMARY =========== -->
47     <A NAME='var_summary'><!-- --></A>
48     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
49     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
50     <TD>
51     <span CLASS="font12bold">Class Variable Summary</span>
52     <A HREF="#top" CLASS="links">^TOP</A>
53     </TD>
54     </TR>
55    
56     <!-- =========== Summary =========== -->
57     <TR BGCOLOR='white' CLASS='TableRowColor'>
58     <TD>
59     <CODE><B><A HREF="../../phpHtmlLib/FormProcessing/FormProcessor.html#var$_confirmed">$_confirmed</A></B></CODE>
60     <BR>
61     <blockquote> Flag to let us know the form has been confirmed. </blockquote>
62     <blockquote> Default Value: <CODE>->&nbsp;FALSE<-</CODE> </blockquote>
63     </TD>
64     </TR>
65     <!-- =========== Summary =========== -->
66     <TR BGCOLOR='white' CLASS='TableRowColor'>
67     <TD>
68     <CODE><B><A HREF="../../phpHtmlLib/FormProcessing/FormProcessor.html#var$_form_action">$_form_action</A></B></CODE>
69     <BR>
70     <blockquote> The action for the form tag </blockquote>
71     <blockquote> Default Value: <CODE>->&nbsp;""<-</CODE> </blockquote>
72     </TD>
73     </TR>
74     <!-- =========== Summary =========== -->
75     <TR BGCOLOR='white' CLASS='TableRowColor'>
76     <TD>
77     <CODE><B><A HREF="../../phpHtmlLib/FormProcessing/FormProcessor.html#var$_form_content">$_form_content</A></B></CODE>
78     <BR>
79     <blockquote> This holds the FormContent Object that knows how to render the form. </blockquote>
80     <blockquote> Default Value: <CODE>->&nbsp;NULL<-</CODE> </blockquote>
81     </TD>
82     </TR>
83     <!-- =========== Summary =========== -->
84     <TR BGCOLOR='white' CLASS='TableRowColor'>
85     <TD>
86     <CODE><B><A HREF="../../phpHtmlLib/FormProcessing/FormProcessor.html#var$_form_enctype">$_form_enctype</A></B></CODE>
87     <BR>
88     <blockquote> The form's enctype attribute. </blockquote>
89     <blockquote> Default Value: <CODE>->&nbsp;NULL<-</CODE> </blockquote>
90     </TD>
91     </TR>
92     <!-- =========== Summary =========== -->
93     <TR BGCOLOR='white' CLASS='TableRowColor'>
94     <TD>
95     <CODE><B><A HREF="../../phpHtmlLib/FormProcessing/FormProcessor.html#var$_form_name">$_form_name</A></B></CODE>
96     <BR>
97     <blockquote> This holds the name of the form </blockquote>
98     <blockquote> Default Value: <CODE>->"forms[0]"<-</CODE> </blockquote>
99     </TD>
100     </TR>
101     <!-- =========== Summary =========== -->
102     <TR BGCOLOR='white' CLASS='TableRowColor'>
103     <TD>
104     <CODE><B><A HREF="../../phpHtmlLib/FormProcessing/FormProcessor.html#var$_form_success_render">$_form_success_render</A></B></CODE>
105     <BR>
106     <blockquote> Flag to let us know if we should </blockquote>
107     <blockquote> Default Value: <CODE>->&nbsp;TRUE<-</CODE> </blockquote>
108     </TD>
109     </TR>
110     <!-- =========== Summary =========== -->
111     <TR BGCOLOR='white' CLASS='TableRowColor'>
112     <TD>
113     <CODE><B><A HREF="../../phpHtmlLib/FormProcessing/FormProcessor.html#var$_has_errors">$_has_errors</A></B></CODE>
114     <BR>
115     <blockquote> This flag lets us know there were errors during processing or validating the form. </blockquote>
116     <blockquote> Default Value: <CODE>->&nbsp;FALSE<-</CODE> </blockquote>
117     </TD>
118     </TR>
119     </TABLE>
120     <hr>
121     <!-- =========== VAR INHERITED SUMMARY =========== -->
122     <A NAME='var_inherited_summary'><!-- --></A>
123     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
124     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
125     <TD>
126     <span CLASS="font12bold">Inherited Class Variable Summary</span>
127     <A HREF="#top" CLASS="links">^TOP</A>
128     </TD>
129     </TR>
130    
131     <!-- =========== Summary =========== -->
132     <TR BGCOLOR='white'>
133     <TD>
134     <span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/Container.html">Container</a></span>
135     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
136     <tr CLASS="tableheadingcolor">
137     <th>Variable</th>
138     <th>Default Value</th>
139     <th>Description</th>
140     </tr>
141     <tr>
142     <td CLASS="font10bold"><a href="../../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></td>
143     <td CLASS="font10" STYLE="white-space: nowrap">-> _NEWLINEAFTERCONTENT<-</td>
144     <td CLASS="font10">The flags that tell us</td>
145     </tr>
146     </table>
147     <BR>
148     </TD>
149     </TR>
150     </TABLE>
151    
152     <hr>
153     <!-- =========== METHOD SUMMARY =========== -->
154     <A NAME='method_summary'><!-- --></A>
155     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
156     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
157     <TD>
158     <span class="font12bold">Method Summary</span>
159     <A HREF="#top" CLASS="links">^TOP</A>
160     </TD>
161     </TR>
162    
163     <!-- =========== Summary =========== -->
164     <TR BGCOLOR='white' CLASS='TableRowColor'>
165     <TD>
166     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormProcessor.html#methodFormProcessor'>void constructor FormProcessor ( &$form_content, [$form_name = "forms[0]"], [$form_action = NULL] )</A></B></CODE>
167     <BR>
168     <blockquote> The constructor for the FormProcessor </blockquote>
169     </TD>
170     </TR>
171     <!-- =========== Summary =========== -->
172     <TR BGCOLOR='white' CLASS='TableRowColor'>
173     <TD>
174     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormProcessor.html#methodcan_validate'>BOOLEAN can_validate ( )</A></B></CODE>
175     <BR>
176     <blockquote> This method lets us turn on/off the ability to do validation for the form </blockquote>
177     </TD>
178     </TR>
179     <!-- =========== Summary =========== -->
180     <TR BGCOLOR='white' CLASS='TableRowColor'>
181     <TD>
182     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormProcessor.html#methoddo_validation'>void do_validation ( )</A></B></CODE>
183     <BR>
184     <blockquote> This method walks the FormContent's visible elements </blockquote>
185     </TD>
186     </TR>
187     <!-- =========== Summary =========== -->
188     <TR BGCOLOR='white' CLASS='TableRowColor'>
189     <TD>
190     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormProcessor.html#methodrender'>void render ( [$indent_level = 0], [$output_debug = 0] )</A></B></CODE>
191     <BR>
192     <blockquote> This method is called to render the form's html </blockquote>
193     </TD>
194     </TR>
195     <!-- =========== Summary =========== -->
196     <TR BGCOLOR='white' CLASS='TableRowColor'>
197     <TD>
198     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormProcessor.html#methodrender_confirm'>string render_confirm ( $indent_level, $output_debug )</A></B></CODE>
199     <BR>
200     <blockquote> This function renders the confirmation page. This page sits in between the front end form, and the action handler. </blockquote>
201     </TD>
202     </TR>
203     <!-- =========== Summary =========== -->
204     <TR BGCOLOR='white' CLASS='TableRowColor'>
205     <TD>
206     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormProcessor.html#methodrender_error'>raw render_error ( $indent_level, $output_debug )</A></B></CODE>
207     <BR>
208     <blockquote> This renders the error table and then the form with the fields </blockquote>
209     </TD>
210     </TR>
211     <!-- =========== Summary =========== -->
212     <TR BGCOLOR='white' CLASS='TableRowColor'>
213     <TD>
214     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormProcessor.html#methodrender_form'>raw render_form ( $indent_level, $output_debug, [$obj = NULL] )</A></B></CODE>
215     <BR>
216     <blockquote> This renders the form </blockquote>
217     </TD>
218     </TR>
219     <!-- =========== Summary =========== -->
220     <TR BGCOLOR='white' CLASS='TableRowColor'>
221     <TD>
222     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormProcessor.html#methodset_render_form_after_success'>void set_render_form_after_success ( )</A></B></CODE>
223     <BR>
224     <blockquote> This function turns on the ability to </blockquote>
225     </TD>
226     </TR>
227     <!-- =========== Summary =========== -->
228     <TR BGCOLOR='white' CLASS='TableRowColor'>
229     <TD>
230     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormProcessor.html#method_add_confirm_data'>void _add_confirm_data ( )</A></B></CODE>
231     <BR>
232     <blockquote> This adds all of the submitted data as </blockquote>
233     </TD>
234     </TR>
235     <!-- =========== Summary =========== -->
236     <TR BGCOLOR='white' CLASS='TableRowColor'>
237     <TD>
238     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormProcessor.html#method_add_hidden_fields'>void _add_hidden_fields ( )</A></B></CODE>
239     <BR>
240     <blockquote> This function adds the form content's </blockquote>
241     </TD>
242     </TR>
243     <!-- =========== Summary =========== -->
244     <TR BGCOLOR='white' CLASS='TableRowColor'>
245     <TD>
246     <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>
247     <BR>
248     <blockquote> this function builds the FORMtag object and its attributes. </blockquote>
249     </TD>
250     </TR>
251     <!-- =========== Summary =========== -->
252     <TR BGCOLOR='white' CLASS='TableRowColor'>
253     <TD>
254     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormProcessor.html#method_pre_confirm'>void _pre_confirm ( )</A></B></CODE>
255     <BR>
256     <blockquote> This method calls the FormContent </blockquote>
257     </TD>
258     </TR>
259     <!-- =========== Summary =========== -->
260     <TR BGCOLOR='white' CLASS='TableRowColor'>
261     <TD>
262     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormProcessor.html#method_process_action'>void _process_action ( )</A></B></CODE>
263     <BR>
264     <blockquote> This function is responsible for processing the form action after validation, and form confirmation happens. </blockquote>
265     </TD>
266     </TR>
267     <!-- =========== Summary =========== -->
268     <TR BGCOLOR='white' CLASS='TableRowColor'>
269     <TD>
270     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormProcessor.html#method_process_form'>void _process_form ( )</A></B></CODE>
271     <BR>
272     <blockquote> This method does the logic of </blockquote>
273     </TD>
274     </TR>
275     <!-- =========== Summary =========== -->
276     <TR BGCOLOR='white' CLASS='TableRowColor'>
277     <TD>
278     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormProcessor.html#method__hidden_fields'>void __hidden_fields ( )</A></B></CODE>
279     <BR>
280     <blockquote> This method adds the processor specific hidden fields. </blockquote>
281     </TD>
282     </TR>
283     </TABLE>
284     <!-- =========== INHERITED METHOD SUMMARY =========== -->
285     <A NAME='functions_inherited'><!-- --></A>
286     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
287     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
288     <TD>
289     <span CLASS="font12bold">Inherited Method Summary</span>
290     <A HREF="#top" CLASS="links">^TOP</A>
291     </TD>
292     </TR>
293    
294     <!-- =========== Summary =========== -->
295     <TR BGCOLOR='white' CLASS='TableRowColor'>
296     <TD>
297     <span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/Container.html">Container</a></span>
298     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
299     <tr CLASS="tableheadingcolor">
300     <th>Function</th>
301     <th>Description</th>
302     </tr>
303     <tr>
304     <td CLASS="font10bold"><a href="../../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></td>
305     <td CLASS="font10">The constructor.</td>
306     <tr>
307     <td CLASS="font10bold"><a href="../../phpHtmlLib/Container.html#methodadd">Container::add()</a></td>
308     <td CLASS="font10">add content onto content stack</td>
309     <tr>
310     <td CLASS="font10bold"><a href="../../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></td>
311     <td CLASS="font10">Add content onto content stack so you can change the item later.</td>
312     <tr>
313     <td CLASS="font10bold"><a href="../../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></td>
314     <td CLASS="font10">counts the number of content objects</td>
315     <tr>
316     <td CLASS="font10bold"><a href="../../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></td>
317     <td CLASS="font10">This flag gets the current value of the indent flag</td>
318     <tr>
319     <td CLASS="font10bold"><a href="../../phpHtmlLib/Container.html#methodpush">Container::push()</a></td>
320     <td CLASS="font10">Same as add().</td>
321     <tr>
322     <td CLASS="font10bold"><a href="../../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></td>
323     <td CLASS="font10">Same as add_reference NOTE : only exists for compatibility with 1.1.x</td>
324     <tr>
325     <td CLASS="font10bold"><a href="../../phpHtmlLib/Container.html#methodrender">Container::render()</a></td>
326     <td CLASS="font10">This function is compatible with the rest of the phpHtmllib API spec.</td>
327     <tr>
328     <td CLASS="font10bold"><a href="../../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></td>
329     <td CLASS="font10">destroy existing content and start with new content.</td>
330     <tr>
331     <td CLASS="font10bold"><a href="../../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></td>
332     <td CLASS="font10">This function turns on the collapse flag</td>
333     <tr>
334     <td CLASS="font10bold"><a href="../../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></td>
335     <td CLASS="font10">function to set the indent flag</td>
336     <tr>
337     <td CLASS="font10bold"><a href="../../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></td>
338     <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>
339     </table>
340     <br>
341     </TD>
342     </TR>
343     </TABLE>
344     <hr>
345     <!-- ============ VARIABLE DETAIL =========== -->
346    
347     <A NAME='variable_detail'></A>
348     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
349     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
350     <TD>
351     <span CLASS="font12bold">Variable Detail</span>
352     <A HREF="#top" CLASS="links">^TOP</A>
353     </TD>
354     </TR>
355     </TABLE>
356    
357     <A NAME='var$_confirmed'><!-- --></A><H3>$_confirmed</H3> (line <span class="linenumber">71</span>)<br />
358     <b>Data type:</b> mixed<br>Flag to let us know the form has been confirmed.
359     <br />
360    
361     <UL>
362     </UL>
363     <HR>
364     <A NAME='var$_form_action'><!-- --></A><H3>$_form_action</H3> (line <span class="linenumber">43</span>)<br />
365     <b>Data type:</b> mixed<br>The action for the form tag
366     <br />
367    
368     <UL>
369     </UL>
370     <HR>
371     <A NAME='var$_form_content'><!-- --></A><H3>$_form_content</H3> (line <span class="linenumber">57</span>)<br />
372     <b>Data type:</b> mixed<br>This holds the FormContent Object that knows how to render the form.
373     <br />
374    
375     <UL>
376     </UL>
377     <HR>
378     <A NAME='var$_form_enctype'><!-- --></A><H3>$_form_enctype</H3> (line <span class="linenumber">50</span>)<br />
379     <b>Data type:</b> mixed<br>The form's enctype attribute.
380     <br />
381     <p>ie &lt;form enctype="multipart/form_data"&gt;</p>
382     <UL>
383     </UL>
384     <HR>
385     <A NAME='var$_form_name'><!-- --></A><H3>$_form_name</H3> (line <span class="linenumber">37</span>)<br />
386     <b>Data type:</b> mixed<br>This holds the name of the form
387     <br />
388     <p>for js that needs it</p>
389     <UL>
390     </UL>
391     <HR>
392     <A NAME='var$_form_success_render'><!-- --></A><H3>$_form_success_render</H3> (line <span class="linenumber">78</span>)<br />
393     <b>Data type:</b> mixed<br>Flag to let us know if we should
394     <br />
395     <p>render the form after it was successfully processed</p>
396     <UL>
397     </UL>
398     <HR>
399     <A NAME='var$_has_errors'><!-- --></A><H3>$_has_errors</H3> (line <span class="linenumber">65</span>)<br />
400     <b>Data type:</b> mixed<br>This flag lets us know there were errors during processing or validating the form.
401     <br />
402    
403     <UL>
404     </UL>
405     <HR>
406     <hr>
407     <!-- ============ METHOD DETAIL =========== -->
408    
409     <A NAME='method_detail'></A>
410     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
411     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
412     <TD>
413     <span class="font12bold">Method Detail</span>
414     <A HREF="#top" CLASS="links">^TOP</A>
415     </TD>
416     </TR>
417     </TABLE>
418     <BR>
419     <DIV CLASS="function">
420     <A NAME='methodFormProcessor'><!-- --></A>
421     <SPAN CLASS="font12bold">Constructor FormProcessor</SPAN> (line <span class="linenumber">87</span>)
422     <BR>
423     <SPAN CLASS="font10bold">Usage : </SPAN>
424     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
425     <span class="font10bold" style="color: #0000FF">FormProcessor(
426     <a href="../../phpHtmlLib/FormProcessing/FormContent.html">FormContent</a>
427     &$form_content, [string
428     $form_name = "forms[0]"], [mixed
429     $form_action = NULL])</SPAN>
430     <BR>
431    
432     <BR>
433     <SPAN CLASS="font10bold">Description : </SPAN>
434     The constructor for the FormProcessor
435     <br />
436    
437     <DL>
438     <DT class="font10bold">Function Parameters:</DT>
439     <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>
440     <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>
441    
442     <DT class="font10bold">Function Info:</DT>
443     </DL>
444     </DIV>
445     <BR>
446     <DIV CLASS="function">
447     <A NAME='methodcan_validate'><!-- --></A>
448     <SPAN CLASS="font12bold">can_validate</SPAN> (line <span class="linenumber">341</span>)
449     <BR>
450     <SPAN CLASS="font10bold">Usage : </SPAN>
451     <span class="font10bold" style="color: #FF0000">BOOLEAN</SPAN>&nbsp;
452     <span class="font10bold" style="color: #0000FF">can_validate(
453     )</SPAN>
454     <BR>
455    
456     <BR>
457     <SPAN CLASS="font10bold">Description : </SPAN>
458     This method lets us turn on/off the ability to do validation for the form
459     <br />
460    
461     <DL>
462    
463     <DT class="font10bold">Function Info:</DT>
464     </DL>
465     </DIV>
466     <BR>
467     <DIV CLASS="function">
468     <A NAME='methoddo_validation'><!-- --></A>
469     <SPAN CLASS="font12bold">do_validation</SPAN> (line <span class="linenumber">193</span>)
470     <BR>
471     <SPAN CLASS="font10bold">Usage : </SPAN>
472     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
473     <span class="font10bold" style="color: #0000FF">do_validation(
474     )</SPAN>
475     <BR>
476    
477     <BR>
478     <SPAN CLASS="font10bold">Description : </SPAN>
479     This method walks the FormContent's visible elements
480     <br />
481     <p>and calls the validation function for the element</p>
482     <DL>
483    
484     <DT class="font10bold">Function Info:</DT>
485     </DL>
486     </DIV>
487     <BR>
488     <DIV CLASS="function">
489     <A NAME='methodrender'><!-- --></A>
490     <SPAN CLASS="font12bold">render</SPAN> (line <span class="linenumber">208</span>)
491     <BR>
492     <SPAN CLASS="font10bold">Usage : </SPAN>
493     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
494     <span class="font10bold" style="color: #0000FF">render(
495     mixed
496     $indent_level, mixed
497     $output_debug)</SPAN>
498     <BR>
499    
500     <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.
501     <BR>
502     <SPAN CLASS="font10bold">Description : </SPAN>
503     This method is called to render the form's html
504     <br />
505    
506     <DL>
507    
508     <DT class="font10bold">Function Info:</DT>
509     </DL>
510     </DIV>
511     <BR>
512     <DIV CLASS="function">
513     <A NAME='methodrender_confirm'><!-- --></A>
514     <SPAN CLASS="font12bold">render_confirm</SPAN> (line <span class="linenumber">288</span>)
515     <BR>
516     <SPAN CLASS="font10bold">Usage : </SPAN>
517     <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
518     <span class="font10bold" style="color: #0000FF">render_confirm(
519     int
520     $indent_level, int
521     $output_debug)</SPAN>
522     <BR>
523    
524     <BR>
525     <SPAN CLASS="font10bold">Description : </SPAN>
526     This function renders the confirmation page. This page sits in between the front end form, and the action handler.
527     <br />
528     <p>This only gets called after a form and its data has been successfully validated.</p>
529     <DL>
530     <DT class="font10bold">Function Parameters:</DT>
531     <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>
532     <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>
533    
534     <DT class="font10bold">Function Info:</DT>
535     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - the raw html</DD>
536     </DL>
537     </DIV>
538     <BR>
539     <DIV CLASS="function">
540     <A NAME='methodrender_error'><!-- --></A>
541     <SPAN CLASS="font12bold">render_error</SPAN> (line <span class="linenumber">317</span>)
542     <BR>
543     <SPAN CLASS="font10bold">Usage : </SPAN>
544     <span class="font10bold" style="color: #FF0000">raw</SPAN>&nbsp;
545     <span class="font10bold" style="color: #0000FF">render_error(
546     array
547     $indent_level, array
548     $output_debug, int
549     2, int
550     3)</SPAN>
551     <BR>
552    
553     <BR>
554     <SPAN CLASS="font10bold">Description : </SPAN>
555     This renders the error table and then the form with the fields
556     <br />
557    
558     <DL>
559     <DT class="font10bold">Function Parameters:</DT>
560     <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>
561     <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>
562     <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>
563     <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>
564    
565     <DT class="font10bold">Function Info:</DT>
566     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - html</DD>
567     </DL>
568     </DIV>
569     <BR>
570     <DIV CLASS="function">
571     <A NAME='methodrender_form'><!-- --></A>
572     <SPAN CLASS="font12bold">render_form</SPAN> (line <span class="linenumber">254</span>)
573     <BR>
574     <SPAN CLASS="font10bold">Usage : </SPAN>
575     <span class="font10bold" style="color: #FF0000">raw</SPAN>&nbsp;
576     <span class="font10bold" style="color: #0000FF">render_form(
577     the
578     $indent_level, int
579     $output_debug, [int
580     $obj = NULL], object
581     3)</SPAN>
582     <BR>
583    
584     <BR>
585     <SPAN CLASS="font10bold">Description : </SPAN>
586     This renders the form
587     <br />
588    
589     <DL>
590     <DT class="font10bold">Function Parameters:</DT>
591     <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>
592     <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>
593     <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>
594     <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>
595    
596     <DT class="font10bold">Function Info:</DT>
597     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - html</DD>
598     </DL>
599     </DIV>
600     <BR>
601     <DIV CLASS="function">
602     <A NAME='methodset_render_form_after_success'><!-- --></A>
603     <SPAN CLASS="font12bold">set_render_form_after_success</SPAN> (line <span class="linenumber">353</span>)
604     <BR>
605     <SPAN CLASS="font10bold">Usage : </SPAN>
606     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
607     <span class="font10bold" style="color: #0000FF">set_render_form_after_success(
608     )</SPAN>
609     <BR>
610    
611     <BR>
612     <SPAN CLASS="font10bold">Description : </SPAN>
613     This function turns on the ability to
614     <br />
615     <p>render the form after the success of the action. Normally this feature is off</p>
616     <DL>
617    
618     <DT class="font10bold">Function Info:</DT>
619     </DL>
620     </DIV>
621     <BR>
622     <DIV CLASS="function">
623     <A NAME='method_add_confirm_data'><!-- --></A>
624     <SPAN CLASS="font12bold">_add_confirm_data</SPAN> (line <span class="linenumber">384</span>)
625     <BR>
626     <SPAN CLASS="font10bold">Usage : </SPAN>
627     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
628     <span class="font10bold" style="color: #0000FF">_add_confirm_data(
629     )</SPAN>
630     <BR>
631    
632     <BR>
633     <SPAN CLASS="font10bold">Description : </SPAN>
634     This adds all of the submitted data as
635     <br />
636     <p>hidden form fields</p>
637     <DL>
638    
639     <DT class="font10bold">Function Info:</DT>
640     </DL>
641     </DIV>
642     <BR>
643     <DIV CLASS="function">
644     <A NAME='method_add_hidden_fields'><!-- --></A>
645     <SPAN CLASS="font12bold">_add_hidden_fields</SPAN> (line <span class="linenumber">412</span>)
646     <BR>
647     <SPAN CLASS="font10bold">Usage : </SPAN>
648     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
649     <span class="font10bold" style="color: #0000FF">_add_hidden_fields(
650     )</SPAN>
651     <BR>
652    
653     <BR>
654     <SPAN CLASS="font10bold">Description : </SPAN>
655     This function adds the form content's
656     <br />
657     <p>hidden form fields to the form automatically</p>
658     <DL>
659    
660     <DT class="font10bold">Function Info:</DT>
661     </DL>
662     </DIV>
663     <BR>
664     <DIV CLASS="function">
665     <A NAME='method_build_form_tag'><!-- --></A>
666     <SPAN CLASS="font12bold">_build_form_tag</SPAN> (line <span class="linenumber">364</span>)
667     <BR>
668     <SPAN CLASS="font10bold">Usage : </SPAN>
669     <span class="font10bold" style="color: #FF0000"><a href="../../phpHtmlLib/FORMtag.html">FORMtag</a></SPAN>&nbsp;
670     <span class="font10bold" style="color: #0000FF">_build_form_tag(
671     )</SPAN>
672     <BR>
673    
674     <BR>
675     <SPAN CLASS="font10bold">Description : </SPAN>
676     this function builds the FORMtag object and its attributes.
677     <br />
678    
679     <DL>
680    
681     <DT class="font10bold">Function Info:</DT>
682     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - object.</DD>
683     </DL>
684     </DIV>
685     <BR>
686     <DIV CLASS="function">
687     <A NAME='method_pre_confirm'><!-- --></A>
688     <SPAN CLASS="font12bold">_pre_confirm</SPAN> (line <span class="linenumber">183</span>)
689     <BR>
690     <SPAN CLASS="font10bold">Usage : </SPAN>
691     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
692     <span class="font10bold" style="color: #0000FF">_pre_confirm(
693     )</SPAN>
694     <BR>
695    
696     <BR>
697     <SPAN CLASS="font10bold">Description : </SPAN>
698     This method calls the FormContent
699     <br />
700     <p>to let it do any data munging before the confirmation page is rendered</p>
701     <DL>
702    
703     <DT class="font10bold">Function Info:</DT>
704     </DL>
705     </DIV>
706     <BR>
707     <DIV CLASS="function">
708     <A NAME='method_process_action'><!-- --></A>
709     <SPAN CLASS="font12bold">_process_action</SPAN> (line <span class="linenumber">173</span>)
710     <BR>
711     <SPAN CLASS="font10bold">Usage : </SPAN>
712     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
713     <span class="font10bold" style="color: #0000FF">_process_action(
714     )</SPAN>
715     <BR>
716    
717     <BR>
718     <SPAN CLASS="font10bold">Description : </SPAN>
719     This function is responsible for processing the form action after validation, and form confirmation happens.
720     <br />
721    
722     <DL>
723    
724     <DT class="font10bold">Function Info:</DT>
725     </DL>
726     </DIV>
727     <BR>
728     <DIV CLASS="function">
729     <A NAME='method_process_form'><!-- --></A>
730     <SPAN CLASS="font12bold">_process_form</SPAN> (line <span class="linenumber">108</span>)
731     <BR>
732     <SPAN CLASS="font10bold">Usage : </SPAN>
733     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
734     <span class="font10bold" style="color: #0000FF">_process_form(
735     )</SPAN>
736     <BR>
737    
738     <BR>
739     <SPAN CLASS="font10bold">Description : </SPAN>
740     This method does the logic of
741     <br />
742     <p>doing the form processing</p>
743     <DL>
744    
745     <DT class="font10bold">Function Info:</DT>
746     </DL>
747     </DIV>
748     <BR>
749     <DIV CLASS="function">
750     <A NAME='method__hidden_fields'><!-- --></A>
751     <SPAN CLASS="font12bold">__hidden_fields</SPAN> (line <span class="linenumber">425</span>)
752     <BR>
753     <SPAN CLASS="font10bold">Usage : </SPAN>
754     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
755     <span class="font10bold" style="color: #0000FF">__hidden_fields(
756     )</SPAN>
757     <BR>
758    
759     <BR>
760     <SPAN CLASS="font10bold">Description : </SPAN>
761     This method adds the processor specific hidden fields.
762     <br />
763    
764     <DL>
765    
766     <DT class="font10bold">Function Info:</DT>
767     </DL>
768     </DIV>
769     <BR>
770     <div id="credit">
771     <hr>
772     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>
773     </div>
774     </body>
775     </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed