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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (hide annotations)
Sat Feb 22 21:05:37 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:23:09 -0800' -->
6     <TITLE>Docs For Class StandardFormContent</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 StandardFormContent">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 StandardFormContent
30     </H2> (line <span class="linenumber">26</span>)
31     <pre>
32     <a href="../../phpHtmlLib/FormProcessing/FormContent.html">FormContent</a>
33     |
34     --StandardFormContent</pre>
35     <SPAN class="type">Classes extended from StandardFormContent:</SPAN>
36     <dl>
37     <dt><a href="../../phpHtmlLib/form-examples/StandardAccountForm.html">StandardAccountForm</a></dt>
38     <dd>A simple Page Layout object child.</dd>
39     </dl>
40     </p>
41     <p>
42     <b><i>Located in File: Program_Root/form/StandardFormContent.inc</i></b><br>
43     </p>
44     <hr>
45     This is a child of the FormContent class to provide a 'standard' look and feel for forms.
46     <br />
47     <p>It also enables a confirmation 'page' by default.</p>
48     <UL>
49     </UL>
50     <hr>
51     <!-- =========== VAR SUMMARY =========== -->
52     <A NAME='var_summary'><!-- --></A>
53     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
54     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
55     <TD>
56     <span CLASS="font12bold">Class Variable Summary</span>
57     <A HREF="#top" CLASS="links">^TOP</A>
58     </TD>
59     </TR>
60    
61     <!-- =========== Summary =========== -->
62     <TR BGCOLOR='white' CLASS='TableRowColor'>
63     <TD>
64     <CODE><B><A HREF="../../phpHtmlLib/FormProcessing/StandardFormContent.html#var$_form_title">$_form_title</A></B></CODE>
65     <BR>
66     <blockquote> The title used in the wrapping table </blockquote>
67     <blockquote> Default Value: <CODE>->&nbsp;""<-</CODE> </blockquote>
68     </TD>
69     </TR>
70     <!-- =========== Summary =========== -->
71     <TR BGCOLOR='white' CLASS='TableRowColor'>
72     <TD>
73     <CODE><B><A HREF="../../phpHtmlLib/FormProcessing/StandardFormContent.html#var$_infotable">$_infotable</A></B></CODE>
74     <BR>
75     <blockquote> the InfoTable wrapper that holds all fields. </blockquote>
76     <blockquote> Default Value: <CODE>->&nbsp;NULL<-</CODE> </blockquote>
77     </TD>
78     </TR>
79     </TABLE>
80     <hr>
81     <!-- =========== VAR INHERITED SUMMARY =========== -->
82     <A NAME='var_inherited_summary'><!-- --></A>
83     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
84     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
85     <TD>
86     <span CLASS="font12bold">Inherited Class Variable Summary</span>
87     <A HREF="#top" CLASS="links">^TOP</A>
88     </TD>
89     </TR>
90    
91     <!-- =========== Summary =========== -->
92     <TR BGCOLOR='white'>
93     <TD>
94     <span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FormContent.html">FormContent</a></span>
95     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
96     <tr CLASS="tableheadingcolor">
97     <th>Variable</th>
98     <th>Default Value</th>
99     <th>Description</th>
100     </tr>
101     <tr>
102     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_action_message">FormContent::$_action_message</a></td>
103     <td CLASS="font10" STYLE="white-space: nowrap">-> ""<-</td>
104     <td CLASS="font10">The message that is set</td>
105     </tr>
106     <tr>
107     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_cancel_action">FormContent::$_cancel_action</a></td>
108     <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>
109     <td CLASS="font10">The action to take opon clicking</td>
110     </tr>
111     <tr>
112     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_default_label_css">FormContent::$_default_label_css</a></td>
113     <td CLASS="font10" STYLE="white-space: nowrap">-> "formlabel"<-</td>
114     <td CLASS="font10">This holds the default css class for form field label text.</td>
115     </tr>
116     <tr>
117     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_elements">FormContent::$_elements</a></td>
118     <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>
119     <td CLASS="font10">This holds the array of</td>
120     </tr>
121     <tr>
122     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_error_label_css">FormContent::$_error_label_css</a></td>
123     <td CLASS="font10" STYLE="white-space: nowrap">-> "formlabelerror"<-</td>
124     <td CLASS="font10">This is the css class used</td>
125     </tr>
126     <tr>
127     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_form_name">FormContent::$_form_name</a></td>
128     <td CLASS="font10" STYLE="white-space: nowrap">-><-</td>
129     <td CLASS="font10">This holds the name of the form</td>
130     </tr>
131     <tr>
132     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_has_confirm">FormContent::$_has_confirm</a></td>
133     <td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td>
134     <td CLASS="font10">flag to let the FormProcessor</td>
135     </tr>
136     <tr>
137     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_hidden_elements">FormContent::$_hidden_elements</a></td>
138     <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>
139     <td CLASS="font10">This holds the array of</td>
140     </tr>
141     <tr>
142     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_required_field_marker">FormContent::$_required_field_marker</a></td>
143     <td CLASS="font10" STYLE="white-space: nowrap">-> "*"<-</td>
144     <td CLASS="font10">marker for the required field</td>
145     </tr>
146     <tr>
147     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_required_field_text">FormContent::$_required_field_text</a></td>
148     <td CLASS="font10" STYLE="white-space: nowrap">-> " - required field"<-</td>
149     <td CLASS="font10">Text to show denoted required fields for the form.</td>
150     </tr>
151     <tr>
152     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_width">FormContent::$_width</a></td>
153     <td CLASS="font10" STYLE="white-space: nowrap">-> "600"<-</td>
154     <td CLASS="font10">Holds the width to be used for the</td>
155     </tr>
156     </table>
157     <BR>
158     </TD>
159     </TR>
160     </TABLE>
161    
162     <hr>
163     <!-- =========== METHOD SUMMARY =========== -->
164     <A NAME='method_summary'><!-- --></A>
165     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
166     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
167     <TD>
168     <span class="font12bold">Method Summary</span>
169     <A HREF="#top" CLASS="links">^TOP</A>
170     </TD>
171     </TR>
172    
173     <!-- =========== Summary =========== -->
174     <TR BGCOLOR='white' CLASS='TableRowColor'>
175     <TD>
176     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/StandardFormContent.html#methodStandardFormContent'>void constructor StandardFormContent ( $title, [$cancel_action = NULL], [$width = "100%"] )</A></B></CODE>
177     <BR>
178     <blockquote> </blockquote>
179     </TD>
180     </TR>
181     <!-- =========== Summary =========== -->
182     <TR BGCOLOR='white' CLASS='TableRowColor'>
183     <TD>
184     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/StandardFormContent.html#methodadd_form_block'>void add_form_block ( [$title = NULL], &$table )</A></B></CODE>
185     <BR>
186     <blockquote> This function is used to add a block of form fields inside a table to this form. </blockquote>
187     </TD>
188     </TR>
189     <!-- =========== Summary =========== -->
190     <TR BGCOLOR='white' CLASS='TableRowColor'>
191     <TD>
192     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/StandardFormContent.html#methodbuild_form_block'><a href="../../phpHtmlLib/FIELDSETtag.html">FIELDSETtag</a> &build_form_block ( [$title = NULL], &$content )</A></B></CODE>
193     <BR>
194     <blockquote> this builds a fieldset and legend and adds the form table to it. </blockquote>
195     </TD>
196     </TR>
197     <!-- =========== Summary =========== -->
198     <TR BGCOLOR='white' CLASS='TableRowColor'>
199     <TD>
200     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/StandardFormContent.html#methodconfirm_action'>void confirm_action ( )</A></B></CODE>
201     <BR>
202     <blockquote> This method is responsible for handling the confirmation page's Confirm action. </blockquote>
203     </TD>
204     </TR>
205     <!-- =========== Summary =========== -->
206     <TR BGCOLOR='white' CLASS='TableRowColor'>
207     <TD>
208     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/StandardFormContent.html#methodform'><a href="../../phpHtmlLib/InfoTable.html">InfoTable</a> form ( )</A></B></CODE>
209     <BR>
210     <blockquote> this builds the main wrapper for the form fields and ads the Save and Cancel buttons </blockquote>
211     </TD>
212     </TR>
213     <!-- =========== Summary =========== -->
214     <TR BGCOLOR='white' CLASS='TableRowColor'>
215     <TD>
216     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/StandardFormContent.html#methodform_action'>boolean form_action ( )</A></B></CODE>
217     <BR>
218     <blockquote> This method handles the form action. </blockquote>
219     </TD>
220     </TR>
221     <!-- =========== Summary =========== -->
222     <TR BGCOLOR='white' CLASS='TableRowColor'>
223     <TD>
224     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/StandardFormContent.html#methodform_confirm'>mixed form_confirm ( )</A></B></CODE>
225     <BR>
226     <blockquote> This function is used to show an intermediary confirmation page. Use this function to show a confirmation of the data that was submitted by the user. </blockquote>
227     </TD>
228     </TR>
229     <!-- =========== Summary =========== -->
230     <TR BGCOLOR='white' CLASS='TableRowColor'>
231     <TD>
232     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/StandardFormContent.html#methodform_content'>void form_content ( &$data, &$err )</A></B></CODE>
233     <BR>
234     <blockquote> Child class MUST override this to provide the form fields </blockquote>
235     </TD>
236     </TR>
237     <!-- =========== Summary =========== -->
238     <TR BGCOLOR='white' CLASS='TableRowColor'>
239     <TD>
240     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/StandardFormContent.html#methodform_content_buttons'>ButtonPanel form_content_buttons ( )</A></B></CODE>
241     <BR>
242     <blockquote> This function is used to build the standard buttons for a form. </blockquote>
243     </TD>
244     </TR>
245     <!-- =========== Summary =========== -->
246     <TR BGCOLOR='white' CLASS='TableRowColor'>
247     <TD>
248     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/StandardFormContent.html#methodset_form_title'>void set_form_title ( $title )</A></B></CODE>
249     <BR>
250     <blockquote> this method sets the form title which is used to wrap the entire form </blockquote>
251     </TD>
252     </TR>
253     <!-- =========== Summary =========== -->
254     <TR BGCOLOR='white' CLASS='TableRowColor'>
255     <TD>
256     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/StandardFormContent.html#method_div_wrapper'>void &_div_wrapper ( )</A></B></CODE>
257     <BR>
258     <blockquote> </blockquote>
259     </TD>
260     </TR>
261     <!-- =========== Summary =========== -->
262     <TR BGCOLOR='white' CLASS='TableRowColor'>
263     <TD>
264     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/StandardFormContent.html#method_form_content_table'>void _form_content_table ( [$width = "100%"], [$border = 0], [$cellspacing = 0], [$cellpadding = 3] )</A></B></CODE>
265     <BR>
266     <blockquote> </blockquote>
267     </TD>
268     </TR>
269     </TABLE>
270     <!-- =========== INHERITED METHOD SUMMARY =========== -->
271     <A NAME='functions_inherited'><!-- --></A>
272     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
273     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
274     <TD>
275     <span CLASS="font12bold">Inherited Method Summary</span>
276     <A HREF="#top" CLASS="links">^TOP</A>
277     </TD>
278     </TR>
279    
280     <!-- =========== Summary =========== -->
281     <TR BGCOLOR='white' CLASS='TableRowColor'>
282     <TD>
283     <span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FormContent.html">FormContent</a></span>
284     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
285     <tr CLASS="tableheadingcolor">
286     <th>Function</th>
287     <th>Description</th>
288     </tr>
289     <tr>
290     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodFormContent">FormContent::FormContent()</a></td>
291     <td CLASS="font10"></td>
292     <tr>
293     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodadd_action">FormContent::add_action()</a></td>
294     <td CLASS="font10">This function adds a form submit button with the appropriate action.</td>
295     <tr>
296     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodadd_cancel">FormContent::add_cancel()</a></td>
297     <td CLASS="font10">build a cancel button with a url to go to</td>
298     <tr>
299     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodadd_element">FormContent::add_element()</a></td>
300     <td CLASS="font10">This method is used to add a form element</td>
301     <tr>
302     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodadd_error">FormContent::add_error()</a></td>
303     <td CLASS="font10">This method is used to create a new error element during the call to form_action(). This enables us to do error handling during a transaction into a DB.</td>
304     <tr>
305     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodadd_hidden_action">FormContent::add_hidden_action()</a></td>
306     <td CLASS="font10">This function adds a submit button that can have any label. It just makes the _form_action a hidden field.</td>
307     <tr>
308     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodadd_hidden_element">FormContent::add_hidden_element()</a></td>
309     <td CLASS="font10">This method is used to add a hidden form field</td>
310     <tr>
311     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodadd_image_action">FormContent::add_image_action()</a></td>
312     <td CLASS="font10">This function adds an action as an image to submit the form.</td>
313     <tr>
314     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodbuild_confirm_table">FormContent::build_confirm_table()</a></td>
315     <td CLASS="font10">This method allows the child to ovveride the default confirm data. By default the form_confirm() will show ALL FormElements. This is prolly not good in case of a form where a password exists.</td>
316     <tr>
317     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodelement_form">FormContent::element_form()</a></td>
318     <td CLASS="font10">This method returns the actual form object that renders the form field.</td>
319     <tr>
320     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodelement_label">FormContent::element_label()</a></td>
321     <td CLASS="font10">This method returns the label object for a visible form element.</td>
322     <tr>
323     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform">FormContent::form()</a></td>
324     <td CLASS="font10">This method builds the html form.</td>
325     <tr>
326     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform_action">FormContent::form_action()</a></td>
327     <td CLASS="font10">This method handles the</td>
328     <tr>
329     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform_backend_validation">FormContent::form_backend_validation()</a></td>
330     <td CLASS="font10">This method is called after the FormElements</td>
331     <tr>
332     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform_confirm">FormContent::form_confirm()</a></td>
333     <td CLASS="font10">This function is used to show an intermediary confirmation page. Use this function to show a confirmation of the data that was submitted by the user.</td>
334     <tr>
335     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform_errors">FormContent::form_errors()</a></td>
336     <td CLASS="font10">This function is used to render the error table for the form. The error data comes from the FormProcessor or the FormValidation.</td>
337     <tr>
338     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform_init_data">FormContent::form_init_data()</a></td>
339     <td CLASS="font10">This method is called by the</td>
340     <tr>
341     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform_init_elements">FormContent::form_init_elements()</a></td>
342     <td CLASS="font10">This method is what is called to build the list of FormElements that will be used by this form.</td>
343     <tr>
344     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform_success">FormContent::form_success()</a></td>
345     <td CLASS="font10">This method is called when the form_action() was successfull, and the form wants to render some kind of message</td>
346     <tr>
347     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodget_action">FormContent::get_action()</a></td>
348     <td CLASS="font10">Get the current status of the action.</td>
349     <tr>
350     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodget_default_css">FormContent::get_default_css()</a></td>
351     <td CLASS="font10">This function returns the default css class used for NON error text.</td>
352     <tr>
353     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodget_element">FormContent::get_element()</a></td>
354     <td CLASS="font10">This method returns the FormElement based on the label.</td>
355     <tr>
356     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodget_element_value">FormContent::get_element_value()</a></td>
357     <td CLASS="font10">This method is used to get the value for a non hidden element</td>
358     <tr>
359     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodget_hidden_element_value">FormContent::get_hidden_element_value()</a></td>
360     <td CLASS="font10">This method is used to get the value for a hidden element</td>
361     <tr>
362     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodget_required_fields_text">FormContent::get_required_fields_text()</a></td>
363     <td CLASS="font10">This returns the required field text</td>
364     <tr>
365     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodhas_confirm">FormContent::has_confirm()</a></td>
366     <td CLASS="font10">This gets the value of the confirmation flag.</td>
367     <tr>
368     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodpre_confirm">FormContent::pre_confirm()</a></td>
369     <td CLASS="font10">This method allows this class to do any data munging prior to the form_confirm method being called @ render time.</td>
370     <tr>
371     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_action">FormContent::set_action()</a></td>
372     <td CLASS="font10">Save the action for the form</td>
373     <tr>
374     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_action_message">FormContent::set_action_message()</a></td>
375     <td CLASS="font10">This sets the action message.</td>
376     <tr>
377     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_cancel_action">FormContent::set_cancel_action()</a></td>
378     <td CLASS="font10">This method sets the javasript action</td>
379     <tr>
380     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_confirm">FormContent::set_confirm()</a></td>
381     <td CLASS="font10">This sets the $this-&gt;_has_confirmation</td>
382     <tr>
383     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_default_css">FormContent::set_default_css()</a></td>
384     <td CLASS="font10">This function is used to set the</td>
385     <tr>
386     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_element_value">FormContent::set_element_value()</a></td>
387     <td CLASS="font10">This method is used to set the value for a non hidden element</td>
388     <tr>
389     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_error_css">FormContent::set_error_css()</a></td>
390     <td CLASS="font10">This function is used to set the css class that is used on text when an error on that field is detected.</td>
391     <tr>
392     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_form_name">FormContent::set_form_name()</a></td>
393     <td CLASS="font10">**************************</td>
394     <tr>
395     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_form_width">FormContent::set_form_width()</a></td>
396     <td CLASS="font10">this method sets the form name</td>
397     <tr>
398     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_hidden_element_value">FormContent::set_hidden_element_value()</a></td>
399     <td CLASS="font10">This method is used to set the value for a hidden element</td>
400     <tr>
401     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_stripslashes">FormContent::set_stripslashes()</a></td>
402     <td CLASS="font10">This sets the stripslashes flag for this object.</td>
403     </table>
404     <br>
405     </TD>
406     </TR>
407     </TABLE>
408     <hr>
409     <!-- ============ VARIABLE DETAIL =========== -->
410    
411     <A NAME='variable_detail'></A>
412     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
413     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
414     <TD>
415     <span CLASS="font12bold">Variable Detail</span>
416     <A HREF="#top" CLASS="links">^TOP</A>
417     </TD>
418     </TR>
419     </TABLE>
420    
421     <A NAME='var$_form_title'><!-- --></A><H3>$_form_title</H3> (line <span class="linenumber">33</span>)<br />
422     <b>Data type:</b> mixed<br>The title used in the wrapping table
423     <br />
424    
425     <UL>
426     </UL>
427     <HR>
428     <A NAME='var$_infotable'><!-- --></A><H3>$_infotable</H3> (line <span class="linenumber">39</span>)<br />
429     <b>Data type:</b> mixed<br>the InfoTable wrapper that holds all fields.
430     <br />
431    
432     <UL>
433     </UL>
434     <HR>
435     <hr>
436     <!-- ============ METHOD DETAIL =========== -->
437    
438     <A NAME='method_detail'></A>
439     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
440     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
441     <TD>
442     <span class="font12bold">Method Detail</span>
443     <A HREF="#top" CLASS="links">^TOP</A>
444     </TD>
445     </TR>
446     </TABLE>
447     <BR>
448     <DIV CLASS="function">
449     <A NAME='methodStandardFormContent'><!-- --></A>
450     <SPAN CLASS="font12bold">Constructor StandardFormContent</SPAN> (line <span class="linenumber">42</span>)
451     <BR>
452     <SPAN CLASS="font10bold">Usage : </SPAN>
453     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
454     <span class="font10bold" style="color: #0000FF">StandardFormContent(
455     mixed
456     $title, [mixed
457     $cancel_action = NULL], [mixed
458     $width = "100%"])</SPAN>
459     <BR>
460    
461     <BR>
462     <SPAN CLASS="font10bold">Description : </SPAN>
463    
464     <br />
465    
466     <DL>
467    
468     <DT class="font10bold">Function Info:</DT>
469     </DL>
470     </DIV>
471     <BR>
472     <DIV CLASS="function">
473     <A NAME='methodadd_form_block'><!-- --></A>
474     <SPAN CLASS="font12bold">add_form_block</SPAN> (line <span class="linenumber">191</span>)
475     <BR>
476     <SPAN CLASS="font10bold">Usage : </SPAN>
477     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
478     <span class="font10bold" style="color: #0000FF">add_form_block(
479     [string
480     $title = NULL], <a href="../../phpHtmlLib/TABLEtag.html">TABLEtag</a>
481     &$table)</SPAN>
482     <BR>
483    
484     <BR>
485     <SPAN CLASS="font10bold">Description : </SPAN>
486     This function is used to add a block of form fields inside a table to this form.
487     <br />
488     <p>This table will automatically get wrapped inside a fieldset with a legend tag to label the block</p>
489     <DL>
490     <DT class="font10bold">Function Parameters:</DT>
491     <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">$title</SPAN></SPAN> - the title for the fieldset</DD>
492     <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;"><a href="../../phpHtmlLib/TABLEtag.html">TABLEtag</a></SPAN> <span style="color: #0000FF;font-weight:bold">&$table</SPAN></SPAN> - the form fields inside a table</DD>
493    
494     <DT class="font10bold">Function Info:</DT>
495     </DL>
496     </DIV>
497     <BR>
498     <DIV CLASS="function">
499     <A NAME='methodbuild_form_block'><!-- --></A>
500     <SPAN CLASS="font12bold">build_form_block</SPAN> (line <span class="linenumber">204</span>)
501     <BR>
502     <SPAN CLASS="font10bold">Usage : </SPAN>
503     <span class="font10bold" style="color: #FF0000"><a href="../../phpHtmlLib/FIELDSETtag.html">FIELDSETtag</a></SPAN>&nbsp;
504     <span class="font10bold" style="color: #0000FF">&amp;build_form_block(
505     [string
506     $title = NULL], <a href="../../phpHtmlLib/TABLEtag.html">TABLEtag</a>
507     &$content)</SPAN>
508     <BR>
509    
510     <BR>
511     <SPAN CLASS="font10bold">Description : </SPAN>
512     this builds a fieldset and legend and adds the form table to it.
513     <br />
514    
515     <DL>
516     <DT class="font10bold">Function Parameters:</DT>
517     <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">$title</SPAN></SPAN> - the legend string</DD>
518     <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;"><a href="../../phpHtmlLib/TABLEtag.html">TABLEtag</a></SPAN> <span style="color: #0000FF;font-weight:bold">&$content</SPAN></SPAN> - the form fields in a table</DD>
519    
520     <DT class="font10bold">Function Info:</DT>
521     </DL>
522     </DIV>
523     <BR>
524     <DIV CLASS="function">
525     <A NAME='methodconfirm_action'><!-- --></A>
526     <SPAN CLASS="font12bold">confirm_action</SPAN> (line <span class="linenumber">158</span>)
527     <BR>
528     <SPAN CLASS="font10bold">Usage : </SPAN>
529     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
530     <span class="font10bold" style="color: #0000FF">confirm_action(
531     )</SPAN>
532     <BR>
533     <p>Overridden in child classes as:<br />
534     <dl>
535     <dt><a href="../../phpHtmlLib/form-examples/StandardAccountForm.html#methodconfirm_action">StandardAccountForm::confirm_action()</a></dt>
536     <dd>This method will get called after all validation has passed, and the confirmation has been accepted.</dd>
537     </dl>
538     </p>
539    
540     <BR>
541     <SPAN CLASS="font10bold">Description : </SPAN>
542     This method is responsible for handling the confirmation page's Confirm action.
543     <br />
544    
545     <DL>
546    
547     <DT class="font10bold">Function Info:</DT>
548     </DL>
549     </DIV>
550     <BR>
551     <DIV CLASS="function">
552     <A NAME='methodform'><!-- --></A>
553     <SPAN CLASS="font12bold">form</SPAN> (line <span class="linenumber">68</span>)
554     <BR>
555     <SPAN CLASS="font10bold">Usage : </SPAN>
556     <span class="font10bold" style="color: #FF0000"><a href="../../phpHtmlLib/InfoTable.html">InfoTable</a></SPAN>&nbsp;
557     <span class="font10bold" style="color: #0000FF">form(
558     array
559     0, array
560     1)</SPAN>
561     <BR>
562    
563     <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform">FormContent::form()</a> This method builds the html form.
564     <BR>
565     <SPAN CLASS="font10bold">Description : </SPAN>
566     this builds the main wrapper for the form fields and ads the Save and Cancel buttons
567     <br />
568    
569     <DL>
570     <DT class="font10bold">Function Parameters:</DT>
571     <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">0</SPAN></SPAN> - the form data</DD>
572     <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">1</SPAN></SPAN> - the form error fields (if any)</DD>
573    
574     <DT class="font10bold">Function Info:</DT>
575     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - widget object</DD>
576     </DL>
577     </DIV>
578     <BR>
579     <DIV CLASS="function">
580     <A NAME='methodform_action'><!-- --></A>
581     <SPAN CLASS="font12bold">form_action</SPAN> (line <span class="linenumber">142</span>)
582     <BR>
583     <SPAN CLASS="font10bold">Usage : </SPAN>
584     <span class="font10bold" style="color: #FF0000">boolean</SPAN>&nbsp;
585     <span class="font10bold" style="color: #0000FF">form_action(
586     )</SPAN>
587     <BR>
588    
589     <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform_action">FormContent::form_action()</a> This method handles the
590     <BR>
591     <SPAN CLASS="font10bold">Description : </SPAN>
592     This method handles the form action.
593     <br />
594    
595     <DL>
596    
597     <DT class="font10bold">Function Info:</DT>
598     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - TRUE = success FALSE = failed.</DD>
599     </DL>
600     </DIV>
601     <BR>
602     <DIV CLASS="function">
603     <A NAME='methodform_confirm'><!-- --></A>
604     <SPAN CLASS="font12bold">form_confirm</SPAN> (line <span class="linenumber">111</span>)
605     <BR>
606     <SPAN CLASS="font10bold">Usage : </SPAN>
607     <span class="font10bold" style="color: #FF0000">mixed</SPAN>&nbsp;
608     <span class="font10bold" style="color: #0000FF">form_confirm(
609     )</SPAN>
610     <BR>
611    
612     <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform_confirm">FormContent::form_confirm()</a> This function is used to show an intermediary confirmation page. Use this function to show a confirmation of the data that was submitted by the user.
613     <BR>
614     <SPAN CLASS="font10bold">Description : </SPAN>
615     This function is used to show an intermediary confirmation page. Use this function to show a confirmation of the data that was submitted by the user.
616     <br />
617     <p>This will get called after all of the form data was successfully validated. All of the form data will automatically be created as hidden form fields. All you have to do is show the data, and a confirm submit button.</p>
618     <DL>
619    
620     <DT class="font10bold">Function Info:</DT>
621     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - either raw html, or some container HTMLTag object.</DD>
622     </DL>
623     </DIV>
624     <BR>
625     <DIV CLASS="function">
626     <A NAME='methodform_content'><!-- --></A>
627     <SPAN CLASS="font12bold">form_content</SPAN> (line <span class="linenumber">91</span>)
628     <BR>
629     <SPAN CLASS="font10bold">Usage : </SPAN>
630     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
631     <span class="font10bold" style="color: #0000FF">form_content(
632     <a href="../../phpHtmlLib/InfoTable.html">InfoTable</a>
633     &$data, the
634     &$err, the
635     2)</SPAN>
636     <BR>
637     <p>Overridden in child classes as:<br />
638     <dl>
639     <dt><a href="../../phpHtmlLib/form-examples/StandardAccountForm.html#methodform_content">StandardAccountForm::form_content()</a></dt>
640     <dd>This method is called by the StandardFormContent object to allow you to build the 'blocks' of fields you want to display. Each form block will live inside a fieldset tag with the a title.</dd>
641     </dl>
642     </p>
643    
644     <BR>
645     <SPAN CLASS="font10bold">Description : </SPAN>
646     Child class MUST override this to provide the form fields
647     <br />
648    
649     <DL>
650     <DT class="font10bold">Function Parameters:</DT>
651     <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">2</SPAN></SPAN> form errors (if any)</DD>
652     <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;"><a href="../../phpHtmlLib/InfoTable.html">InfoTable</a></SPAN> <span style="color: #0000FF;font-weight:bold">&$data</SPAN></SPAN> object that is the wrapper</DD>
653     <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">&$err</SPAN></SPAN> form data array</DD>
654    
655     <DT class="font10bold">Function Info:</DT>
656     </DL>
657     </DIV>
658     <BR>
659     <DIV CLASS="function">
660     <A NAME='methodform_content_buttons'><!-- --></A>
661     <SPAN CLASS="font12bold">form_content_buttons</SPAN> (line <span class="linenumber">170</span>)
662     <BR>
663     <SPAN CLASS="font10bold">Usage : </SPAN>
664     <span class="font10bold" style="color: #FF0000">ButtonPanel</SPAN>&nbsp;
665     <span class="font10bold" style="color: #0000FF">form_content_buttons(
666     )</SPAN>
667     <BR>
668    
669     <BR>
670     <SPAN CLASS="font10bold">Description : </SPAN>
671     This function is used to build the standard buttons for a form.
672     <br />
673    
674     <DL>
675    
676     <DT class="font10bold">Function Info:</DT>
677     </DL>
678     </DIV>
679     <BR>
680     <DIV CLASS="function">
681     <A NAME='methodset_form_title'><!-- --></A>
682     <SPAN CLASS="font12bold">set_form_title</SPAN> (line <span class="linenumber">56</span>)
683     <BR>
684     <SPAN CLASS="font10bold">Usage : </SPAN>
685     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
686     <span class="font10bold" style="color: #0000FF">set_form_title(
687     string
688     $title)</SPAN>
689     <BR>
690    
691     <BR>
692     <SPAN CLASS="font10bold">Description : </SPAN>
693     this method sets the form title which is used to wrap the entire form
694     <br />
695    
696     <DL>
697     <DT class="font10bold">Function Parameters:</DT>
698     <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">$title</SPAN></SPAN> - the form title</DD>
699    
700     <DT class="font10bold">Function Info:</DT>
701     </DL>
702     </DIV>
703     <BR>
704     <DIV CLASS="function">
705     <A NAME='method_div_wrapper'><!-- --></A>
706     <SPAN CLASS="font12bold">_div_wrapper</SPAN> (line <span class="linenumber">217</span>)
707     <BR>
708     <SPAN CLASS="font10bold">Usage : </SPAN>
709     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
710     <span class="font10bold" style="color: #0000FF">&amp;_div_wrapper(
711     )</SPAN>
712     <BR>
713    
714     <BR>
715     <SPAN CLASS="font10bold">Description : </SPAN>
716    
717     <br />
718    
719     <DL>
720    
721     <DT class="font10bold">Function Info:</DT>
722     </DL>
723     </DIV>
724     <BR>
725     <DIV CLASS="function">
726     <A NAME='method_form_content_table'><!-- --></A>
727     <SPAN CLASS="font12bold">_form_content_table</SPAN> (line <span class="linenumber">223</span>)
728     <BR>
729     <SPAN CLASS="font10bold">Usage : </SPAN>
730     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
731     <span class="font10bold" style="color: #0000FF">_form_content_table(
732     [mixed
733     $width = "100%"], mixed
734     $border, mixed
735     $cellspacing, [mixed
736     $cellpadding = 3])</SPAN>
737     <BR>
738    
739     <BR>
740     <SPAN CLASS="font10bold">Description : </SPAN>
741    
742     <br />
743    
744     <DL>
745    
746     <DT class="font10bold">Function Info:</DT>
747     </DL>
748     </DIV>
749     <BR>
750     <div id="credit">
751     <hr>
752     Documention generated on Thu, 20 Feb 2003 16:23:09 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a>
753     </div>
754     </body>
755     </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed