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 15:30:34 -0800' --> |
6 |
<TITLE>Docs For Class MyFormContent</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 MyFormContent">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 MyFormContent |
30 |
</H2> (line <span class="linenumber">43</span>) |
31 |
<pre> |
32 |
<a href="../../phpHtmlLib/FormProcessing/FormContent.html">FormContent</a> |
33 |
| |
34 |
--<a href="../../phpHtmlLib/FormProcessing/StandardFormContent.html">StandardFormContent</a> |
35 |
| |
36 |
--MyFormContent</pre> |
37 |
<p> |
38 |
<b><i>Located in File: Program_Root/examples/form2.php</i></b><br> |
39 |
</p> |
40 |
<hr> |
41 |
This is a child of the FormContent class to provide a 'standard' look and feel for forms. |
42 |
<br /> |
43 |
<p>It also enables a confirmation 'page' by default.</p> |
44 |
<UL> |
45 |
</UL> |
46 |
<hr> |
47 |
<!-- =========== VAR SUMMARY =========== --> |
48 |
<A NAME='var_summary'><!-- --></A> |
49 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
50 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
51 |
<TD> |
52 |
<span CLASS="font12bold">Class Variable Summary</span> |
53 |
<A HREF="#top" CLASS="links">^TOP</A> |
54 |
</TD> |
55 |
</TR> |
56 |
|
57 |
</TABLE> |
58 |
<hr> |
59 |
<!-- =========== VAR INHERITED SUMMARY =========== --> |
60 |
<A NAME='var_inherited_summary'><!-- --></A> |
61 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
62 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
63 |
<TD> |
64 |
<span CLASS="font12bold">Inherited Class Variable Summary</span> |
65 |
<A HREF="#top" CLASS="links">^TOP</A> |
66 |
</TD> |
67 |
</TR> |
68 |
|
69 |
<!-- =========== Summary =========== --> |
70 |
<TR BGCOLOR='white'> |
71 |
<TD> |
72 |
<span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/StandardFormContent.html">StandardFormContent</a></span> |
73 |
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
74 |
<tr CLASS="tableheadingcolor"> |
75 |
<th>Variable</th> |
76 |
<th>Default Value</th> |
77 |
<th>Description</th> |
78 |
</tr> |
79 |
<tr> |
80 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/StandardFormContent.html#var$_form_title">StandardFormContent::$_form_title</a></td> |
81 |
<td CLASS="font10" STYLE="white-space: nowrap">-> ""<-</td> |
82 |
<td CLASS="font10">The title used in the wrapping table</td> |
83 |
</tr> |
84 |
<tr> |
85 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/StandardFormContent.html#var$_infotable">StandardFormContent::$_infotable</a></td> |
86 |
<td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td> |
87 |
<td CLASS="font10">the InfoTable wrapper that holds all fields.</td> |
88 |
</tr> |
89 |
</table> |
90 |
<BR> |
91 |
</TD> |
92 |
</TR> |
93 |
<!-- =========== Summary =========== --> |
94 |
<TR BGCOLOR='white'> |
95 |
<TD> |
96 |
<span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FormContent.html">FormContent</a></span> |
97 |
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
98 |
<tr CLASS="tableheadingcolor"> |
99 |
<th>Variable</th> |
100 |
<th>Default Value</th> |
101 |
<th>Description</th> |
102 |
</tr> |
103 |
<tr> |
104 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_action_message">FormContent::$_action_message</a></td> |
105 |
<td CLASS="font10" STYLE="white-space: nowrap">-> ""<-</td> |
106 |
<td CLASS="font10">The message that is set</td> |
107 |
</tr> |
108 |
<tr> |
109 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_cancel_action">FormContent::$_cancel_action</a></td> |
110 |
<td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td> |
111 |
<td CLASS="font10">The action to take opon clicking</td> |
112 |
</tr> |
113 |
<tr> |
114 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_default_label_css">FormContent::$_default_label_css</a></td> |
115 |
<td CLASS="font10" STYLE="white-space: nowrap">-> "formlabel"<-</td> |
116 |
<td CLASS="font10">This holds the default css class for form field label text.</td> |
117 |
</tr> |
118 |
<tr> |
119 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_elements">FormContent::$_elements</a></td> |
120 |
<td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td> |
121 |
<td CLASS="font10">This holds the array of</td> |
122 |
</tr> |
123 |
<tr> |
124 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_error_label_css">FormContent::$_error_label_css</a></td> |
125 |
<td CLASS="font10" STYLE="white-space: nowrap">-> "formlabelerror"<-</td> |
126 |
<td CLASS="font10">This is the css class used</td> |
127 |
</tr> |
128 |
<tr> |
129 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_form_name">FormContent::$_form_name</a></td> |
130 |
<td CLASS="font10" STYLE="white-space: nowrap">-><-</td> |
131 |
<td CLASS="font10">This holds the name of the form</td> |
132 |
</tr> |
133 |
<tr> |
134 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_has_confirm">FormContent::$_has_confirm</a></td> |
135 |
<td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td> |
136 |
<td CLASS="font10">flag to let the FormProcessor</td> |
137 |
</tr> |
138 |
<tr> |
139 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_hidden_elements">FormContent::$_hidden_elements</a></td> |
140 |
<td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td> |
141 |
<td CLASS="font10">This holds the array of</td> |
142 |
</tr> |
143 |
<tr> |
144 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_required_field_marker">FormContent::$_required_field_marker</a></td> |
145 |
<td CLASS="font10" STYLE="white-space: nowrap">-> "*"<-</td> |
146 |
<td CLASS="font10">marker for the required field</td> |
147 |
</tr> |
148 |
<tr> |
149 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_required_field_text">FormContent::$_required_field_text</a></td> |
150 |
<td CLASS="font10" STYLE="white-space: nowrap">-> " - required field"<-</td> |
151 |
<td CLASS="font10">Text to show denoted required fields for the form.</td> |
152 |
</tr> |
153 |
<tr> |
154 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_width">FormContent::$_width</a></td> |
155 |
<td CLASS="font10" STYLE="white-space: nowrap">-> "600"<-</td> |
156 |
<td CLASS="font10">Holds the width to be used for the</td> |
157 |
</tr> |
158 |
</table> |
159 |
<BR> |
160 |
</TD> |
161 |
</TR> |
162 |
</TABLE> |
163 |
|
164 |
<hr> |
165 |
<!-- =========== METHOD SUMMARY =========== --> |
166 |
<A NAME='method_summary'><!-- --></A> |
167 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> |
168 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
169 |
<TD> |
170 |
<span class="font12bold">Method Summary</span> |
171 |
<A HREF="#top" CLASS="links">^TOP</A> |
172 |
</TD> |
173 |
</TR> |
174 |
|
175 |
<!-- =========== Summary =========== --> |
176 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
177 |
<TD> |
178 |
<CODE><B><A HREF='../../phpHtmlLib/widget-examples/MyFormContent.html#methodconfirm_action'>void confirm_action ( )</A></B></CODE> |
179 |
<BR> |
180 |
<blockquote> </blockquote> |
181 |
</TD> |
182 |
</TR> |
183 |
<!-- =========== Summary =========== --> |
184 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
185 |
<TD> |
186 |
<CODE><B><A HREF='../../phpHtmlLib/widget-examples/MyFormContent.html#methodform_backend_validation'>void form_backend_validation ( )</A></B></CODE> |
187 |
<BR> |
188 |
<blockquote> </blockquote> |
189 |
</TD> |
190 |
</TR> |
191 |
<!-- =========== Summary =========== --> |
192 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
193 |
<TD> |
194 |
<CODE><B><A HREF='../../phpHtmlLib/widget-examples/MyFormContent.html#methodform_content'>void form_content ( )</A></B></CODE> |
195 |
<BR> |
196 |
<blockquote> </blockquote> |
197 |
</TD> |
198 |
</TR> |
199 |
<!-- =========== Summary =========== --> |
200 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
201 |
<TD> |
202 |
<CODE><B><A HREF='../../phpHtmlLib/widget-examples/MyFormContent.html#methodform_init_data'>void form_init_data ( )</A></B></CODE> |
203 |
<BR> |
204 |
<blockquote> This method is called only the first time the form page is hit. </blockquote> |
205 |
</TD> |
206 |
</TR> |
207 |
<!-- =========== Summary =========== --> |
208 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
209 |
<TD> |
210 |
<CODE><B><A HREF='../../phpHtmlLib/widget-examples/MyFormContent.html#methodform_init_elements'>void form_init_elements ( )</A></B></CODE> |
211 |
<BR> |
212 |
<blockquote> This method gets called EVERY time the object is </blockquote> |
213 |
</TD> |
214 |
</TR> |
215 |
<!-- =========== Summary =========== --> |
216 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
217 |
<TD> |
218 |
<CODE><B><A HREF='../../phpHtmlLib/widget-examples/MyFormContent.html#method_foo_info'>void _foo_info ( )</A></B></CODE> |
219 |
<BR> |
220 |
<blockquote> </blockquote> |
221 |
</TD> |
222 |
</TR> |
223 |
<!-- =========== Summary =========== --> |
224 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
225 |
<TD> |
226 |
<CODE><B><A HREF='../../phpHtmlLib/widget-examples/MyFormContent.html#method_user_info'>void _user_info ( )</A></B></CODE> |
227 |
<BR> |
228 |
<blockquote> </blockquote> |
229 |
</TD> |
230 |
</TR> |
231 |
</TABLE> |
232 |
<!-- =========== INHERITED METHOD SUMMARY =========== --> |
233 |
<A NAME='functions_inherited'><!-- --></A> |
234 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
235 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
236 |
<TD> |
237 |
<span CLASS="font12bold">Inherited Method Summary</span> |
238 |
<A HREF="#top" CLASS="links">^TOP</A> |
239 |
</TD> |
240 |
</TR> |
241 |
|
242 |
<!-- =========== Summary =========== --> |
243 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
244 |
<TD> |
245 |
<span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/StandardFormContent.html">StandardFormContent</a></span> |
246 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
247 |
<tr CLASS="tableheadingcolor"> |
248 |
<th>Function</th> |
249 |
<th>Description</th> |
250 |
</tr> |
251 |
<tr> |
252 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/StandardFormContent.html#methodStandardFormContent">StandardFormContent::StandardFormContent()</a></td> |
253 |
<td CLASS="font10"></td> |
254 |
<tr> |
255 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/StandardFormContent.html#methodadd_form_block">StandardFormContent::add_form_block()</a></td> |
256 |
<td CLASS="font10">This function is used to add a block of form fields inside a table to this form.</td> |
257 |
<tr> |
258 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/StandardFormContent.html#methodbuild_form_block">StandardFormContent::build_form_block()</a></td> |
259 |
<td CLASS="font10">this builds a fieldset and legend and adds the form table to it.</td> |
260 |
<tr> |
261 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/StandardFormContent.html#methodconfirm_action">StandardFormContent::confirm_action()</a></td> |
262 |
<td CLASS="font10">This method is responsible for handling the confirmation page's Confirm action.</td> |
263 |
<tr> |
264 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/StandardFormContent.html#methodform">StandardFormContent::form()</a></td> |
265 |
<td CLASS="font10">this builds the main wrapper for the form fields and ads the Save and Cancel buttons</td> |
266 |
<tr> |
267 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/StandardFormContent.html#methodform_action">StandardFormContent::form_action()</a></td> |
268 |
<td CLASS="font10">This method handles the form action.</td> |
269 |
<tr> |
270 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/StandardFormContent.html#methodform_confirm">StandardFormContent::form_confirm()</a></td> |
271 |
<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> |
272 |
<tr> |
273 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/StandardFormContent.html#methodform_content">StandardFormContent::form_content()</a></td> |
274 |
<td CLASS="font10">Child class MUST override this to provide the form fields</td> |
275 |
<tr> |
276 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/StandardFormContent.html#methodform_content_buttons">StandardFormContent::form_content_buttons()</a></td> |
277 |
<td CLASS="font10">This function is used to build the standard buttons for a form.</td> |
278 |
<tr> |
279 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/StandardFormContent.html#methodset_form_title">StandardFormContent::set_form_title()</a></td> |
280 |
<td CLASS="font10">this method sets the form title which is used to wrap the entire form</td> |
281 |
<tr> |
282 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/StandardFormContent.html#method_div_wrapper">StandardFormContent::_div_wrapper()</a></td> |
283 |
<td CLASS="font10"></td> |
284 |
<tr> |
285 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/StandardFormContent.html#method_form_content_table">StandardFormContent::_form_content_table()</a></td> |
286 |
<td CLASS="font10"></td> |
287 |
</table> |
288 |
<br> |
289 |
</TD> |
290 |
</TR> |
291 |
<!-- =========== Summary =========== --> |
292 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
293 |
<TD> |
294 |
<span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FormContent.html">FormContent</a></span> |
295 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
296 |
<tr CLASS="tableheadingcolor"> |
297 |
<th>Function</th> |
298 |
<th>Description</th> |
299 |
</tr> |
300 |
<tr> |
301 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodFormContent">FormContent::FormContent()</a></td> |
302 |
<td CLASS="font10"></td> |
303 |
<tr> |
304 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodadd_action">FormContent::add_action()</a></td> |
305 |
<td CLASS="font10">This function adds a form submit button with the appropriate action.</td> |
306 |
<tr> |
307 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodadd_cancel">FormContent::add_cancel()</a></td> |
308 |
<td CLASS="font10">build a cancel button with a url to go to</td> |
309 |
<tr> |
310 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodadd_element">FormContent::add_element()</a></td> |
311 |
<td CLASS="font10">This method is used to add a form element</td> |
312 |
<tr> |
313 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodadd_error">FormContent::add_error()</a></td> |
314 |
<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> |
315 |
<tr> |
316 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodadd_hidden_action">FormContent::add_hidden_action()</a></td> |
317 |
<td CLASS="font10">This function adds a submit button that can have any label. It just makes the _form_action a hidden field.</td> |
318 |
<tr> |
319 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodadd_hidden_element">FormContent::add_hidden_element()</a></td> |
320 |
<td CLASS="font10">This method is used to add a hidden form field</td> |
321 |
<tr> |
322 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodadd_image_action">FormContent::add_image_action()</a></td> |
323 |
<td CLASS="font10">This function adds an action as an image to submit the form.</td> |
324 |
<tr> |
325 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodbuild_confirm_table">FormContent::build_confirm_table()</a></td> |
326 |
<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> |
327 |
<tr> |
328 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodelement_form">FormContent::element_form()</a></td> |
329 |
<td CLASS="font10">This method returns the actual form object that renders the form field.</td> |
330 |
<tr> |
331 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodelement_label">FormContent::element_label()</a></td> |
332 |
<td CLASS="font10">This method returns the label object for a visible form element.</td> |
333 |
<tr> |
334 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform">FormContent::form()</a></td> |
335 |
<td CLASS="font10">This method builds the html form.</td> |
336 |
<tr> |
337 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform_action">FormContent::form_action()</a></td> |
338 |
<td CLASS="font10">This method handles the</td> |
339 |
<tr> |
340 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform_backend_validation">FormContent::form_backend_validation()</a></td> |
341 |
<td CLASS="font10">This method is called after the FormElements</td> |
342 |
<tr> |
343 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform_confirm">FormContent::form_confirm()</a></td> |
344 |
<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> |
345 |
<tr> |
346 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform_errors">FormContent::form_errors()</a></td> |
347 |
<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> |
348 |
<tr> |
349 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform_init_data">FormContent::form_init_data()</a></td> |
350 |
<td CLASS="font10">This method is called by the</td> |
351 |
<tr> |
352 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform_init_elements">FormContent::form_init_elements()</a></td> |
353 |
<td CLASS="font10">This method is what is called to build the list of FormElements that will be used by this form.</td> |
354 |
<tr> |
355 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform_success">FormContent::form_success()</a></td> |
356 |
<td CLASS="font10">This method is called when the form_action() was successfull, and the form wants to render some kind of message</td> |
357 |
<tr> |
358 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodget_action">FormContent::get_action()</a></td> |
359 |
<td CLASS="font10">Get the current status of the action.</td> |
360 |
<tr> |
361 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodget_default_css">FormContent::get_default_css()</a></td> |
362 |
<td CLASS="font10">This function returns the default css class used for NON error text.</td> |
363 |
<tr> |
364 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodget_element">FormContent::get_element()</a></td> |
365 |
<td CLASS="font10">This method returns the FormElement based on the label.</td> |
366 |
<tr> |
367 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodget_element_value">FormContent::get_element_value()</a></td> |
368 |
<td CLASS="font10">This method is used to get the value for a non hidden element</td> |
369 |
<tr> |
370 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodget_hidden_element_value">FormContent::get_hidden_element_value()</a></td> |
371 |
<td CLASS="font10">This method is used to get the value for a hidden element</td> |
372 |
<tr> |
373 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodget_required_fields_text">FormContent::get_required_fields_text()</a></td> |
374 |
<td CLASS="font10">This returns the required field text</td> |
375 |
<tr> |
376 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodhas_confirm">FormContent::has_confirm()</a></td> |
377 |
<td CLASS="font10">This gets the value of the confirmation flag.</td> |
378 |
<tr> |
379 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodpre_confirm">FormContent::pre_confirm()</a></td> |
380 |
<td CLASS="font10">This method allows this class to do any data munging prior to the form_confirm method being called @ render time.</td> |
381 |
<tr> |
382 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_action">FormContent::set_action()</a></td> |
383 |
<td CLASS="font10">Save the action for the form</td> |
384 |
<tr> |
385 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_action_message">FormContent::set_action_message()</a></td> |
386 |
<td CLASS="font10">This sets the action message.</td> |
387 |
<tr> |
388 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_cancel_action">FormContent::set_cancel_action()</a></td> |
389 |
<td CLASS="font10">This method sets the javasript action</td> |
390 |
<tr> |
391 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_confirm">FormContent::set_confirm()</a></td> |
392 |
<td CLASS="font10">This sets the $this->_has_confirmation</td> |
393 |
<tr> |
394 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_default_css">FormContent::set_default_css()</a></td> |
395 |
<td CLASS="font10">This function is used to set the</td> |
396 |
<tr> |
397 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_element_value">FormContent::set_element_value()</a></td> |
398 |
<td CLASS="font10">This method is used to set the value for a non hidden element</td> |
399 |
<tr> |
400 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_error_css">FormContent::set_error_css()</a></td> |
401 |
<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> |
402 |
<tr> |
403 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_form_name">FormContent::set_form_name()</a></td> |
404 |
<td CLASS="font10">**************************</td> |
405 |
<tr> |
406 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_form_width">FormContent::set_form_width()</a></td> |
407 |
<td CLASS="font10">this method sets the form name</td> |
408 |
<tr> |
409 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_hidden_element_value">FormContent::set_hidden_element_value()</a></td> |
410 |
<td CLASS="font10">This method is used to set the value for a hidden element</td> |
411 |
<tr> |
412 |
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_stripslashes">FormContent::set_stripslashes()</a></td> |
413 |
<td CLASS="font10">This sets the stripslashes flag for this object.</td> |
414 |
</table> |
415 |
<br> |
416 |
</TD> |
417 |
</TR> |
418 |
</TABLE> |
419 |
<hr> |
420 |
<!-- ============ VARIABLE DETAIL =========== --> |
421 |
|
422 |
<A NAME='variable_detail'></A> |
423 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
424 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
425 |
<TD> |
426 |
<span CLASS="font12bold">Variable Detail</span> |
427 |
<A HREF="#top" CLASS="links">^TOP</A> |
428 |
</TD> |
429 |
</TR> |
430 |
</TABLE> |
431 |
|
432 |
<hr> |
433 |
<!-- ============ METHOD DETAIL =========== --> |
434 |
|
435 |
<A NAME='method_detail'></A> |
436 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
437 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
438 |
<TD> |
439 |
<span class="font12bold">Method Detail</span> |
440 |
<A HREF="#top" CLASS="links">^TOP</A> |
441 |
</TD> |
442 |
</TR> |
443 |
</TABLE> |
444 |
<BR> |
445 |
<DIV CLASS="function"> |
446 |
<A NAME='methodconfirm_action'><!-- --></A> |
447 |
<SPAN CLASS="font12bold">confirm_action</SPAN> (line <span class="linenumber">124</span>) |
448 |
<BR> |
449 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
450 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
451 |
<span class="font10bold" style="color: #0000FF">confirm_action( |
452 |
)</SPAN> |
453 |
<BR> |
454 |
|
455 |
<span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../../phpHtmlLib/FormProcessing/StandardFormContent.html#methodconfirm_action">StandardFormContent::confirm_action()</a> This method is responsible for handling the confirmation page's Confirm action. |
456 |
<BR> |
457 |
<SPAN CLASS="font10bold">Description : </SPAN> |
458 |
|
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='methodform_backend_validation'><!-- --></A> |
469 |
<SPAN CLASS="font12bold">form_backend_validation</SPAN> (line <span class="linenumber">117</span>) |
470 |
<BR> |
471 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
472 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
473 |
<span class="font10bold" style="color: #0000FF">form_backend_validation( |
474 |
)</SPAN> |
475 |
<BR> |
476 |
|
477 |
<BR> |
478 |
<SPAN CLASS="font10bold">Description : </SPAN> |
479 |
|
480 |
<br /> |
481 |
|
482 |
<DL> |
483 |
|
484 |
<DT class="font10bold">Function Info:</DT> |
485 |
</DL> |
486 |
</DIV> |
487 |
<BR> |
488 |
<DIV CLASS="function"> |
489 |
<A NAME='methodform_content'><!-- --></A> |
490 |
<SPAN CLASS="font12bold">form_content</SPAN> (line <span class="linenumber">85</span>) |
491 |
<BR> |
492 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
493 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
494 |
<span class="font10bold" style="color: #0000FF">form_content( |
495 |
)</SPAN> |
496 |
<BR> |
497 |
|
498 |
<span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../../phpHtmlLib/FormProcessing/StandardFormContent.html#methodform_content">StandardFormContent::form_content()</a> Child class MUST override this to provide the form fields |
499 |
<BR> |
500 |
<SPAN CLASS="font10bold">Description : </SPAN> |
501 |
|
502 |
<br /> |
503 |
|
504 |
<DL> |
505 |
|
506 |
<DT class="font10bold">Function Info:</DT> |
507 |
</DL> |
508 |
</DIV> |
509 |
<BR> |
510 |
<DIV CLASS="function"> |
511 |
<A NAME='methodform_init_data'><!-- --></A> |
512 |
<SPAN CLASS="font12bold">form_init_data</SPAN> (line <span class="linenumber">78</span>) |
513 |
<BR> |
514 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
515 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
516 |
<span class="font10bold" style="color: #0000FF">form_init_data( |
517 |
)</SPAN> |
518 |
<BR> |
519 |
|
520 |
<BR> |
521 |
<SPAN CLASS="font10bold">Description : </SPAN> |
522 |
This method is called only the first time the form page is hit. |
523 |
<br /> |
524 |
|
525 |
<DL> |
526 |
|
527 |
<DT class="font10bold">Function Info:</DT> |
528 |
</DL> |
529 |
</DIV> |
530 |
<BR> |
531 |
<DIV CLASS="function"> |
532 |
<A NAME='methodform_init_elements'><!-- --></A> |
533 |
<SPAN CLASS="font12bold">form_init_elements</SPAN> (line <span class="linenumber">49</span>) |
534 |
<BR> |
535 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
536 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
537 |
<span class="font10bold" style="color: #0000FF">form_init_elements( |
538 |
)</SPAN> |
539 |
<BR> |
540 |
|
541 |
<BR> |
542 |
<SPAN CLASS="font10bold">Description : </SPAN> |
543 |
This method gets called EVERY time the object is |
544 |
<br /> |
545 |
<p>created</p> |
546 |
<DL> |
547 |
|
548 |
<DT class="font10bold">Function Info:</DT> |
549 |
</DL> |
550 |
</DIV> |
551 |
<BR> |
552 |
<DIV CLASS="function"> |
553 |
<A NAME='method_foo_info'><!-- --></A> |
554 |
<SPAN CLASS="font12bold">_foo_info</SPAN> (line <span class="linenumber">105</span>) |
555 |
<BR> |
556 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
557 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
558 |
<span class="font10bold" style="color: #0000FF">_foo_info( |
559 |
)</SPAN> |
560 |
<BR> |
561 |
|
562 |
<BR> |
563 |
<SPAN CLASS="font10bold">Description : </SPAN> |
564 |
|
565 |
<br /> |
566 |
|
567 |
<DL> |
568 |
|
569 |
<DT class="font10bold">Function Info:</DT> |
570 |
</DL> |
571 |
</DIV> |
572 |
<BR> |
573 |
<DIV CLASS="function"> |
574 |
<A NAME='method_user_info'><!-- --></A> |
575 |
<SPAN CLASS="font12bold">_user_info</SPAN> (line <span class="linenumber">91</span>) |
576 |
<BR> |
577 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
578 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
579 |
<span class="font10bold" style="color: #0000FF">_user_info( |
580 |
)</SPAN> |
581 |
<BR> |
582 |
|
583 |
<BR> |
584 |
<SPAN CLASS="font10bold">Description : </SPAN> |
585 |
|
586 |
<br /> |
587 |
|
588 |
<DL> |
589 |
|
590 |
<DT class="font10bold">Function Info:</DT> |
591 |
</DL> |
592 |
</DIV> |
593 |
<BR> |
594 |
<div id="credit"> |
595 |
<hr> |
596 |
Documention generated on Thu, 20 Feb 2003 15:30:34 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a> |
597 |
</div> |
598 |
</body> |
599 |
</html> |