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