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

Contents of /nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/FormProcessing/FormContent.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.3 - (show annotations)
Thu May 6 16:26:16 2004 UTC (20 years, 3 months ago) by jonen
Branch: MAIN
CVS Tags: HEAD
Changes since 1.2: +2305 -2111 lines
File MIME type: text/html 
 updated all to v2.4.1 - Apr 01, 2004
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <!-- template designed by Marco Von Ballmoos -->
6 <title>Docs For Class FormContent</title>
7 <link rel="stylesheet" href="../../media/stylesheet.css" />
8 <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9 </head>
10 <body>
11 <div class="page-body">
12
13 <h2 class="class-name">Class FormContent</h2>
14
15 <a name="sec-description"></a>
16 <div class="info-box">
17 <div class="info-box-title">Description</div>
18 <div class="nav-bar">
19 <span class="disabled">Description</span> |
20 <a href="#sec-descendents">Descendents</a>
21 | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
22 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
23
24 </div>
25 <div class="info-box-body">
26 <!-- ========== Info from phpDoc block ========= -->
27 <p class="short-description">This class is used to build and render the form.</p>
28 <p class="description"><p>It builds a form by creating FormElement objects which have automatic validation. It leaves the layout of the form up to the child class. It has a mechanism in place to automagically show a confirmation 'page' after the data has been submitted and validated. It also provides a hook for any 'back end' validation of data. Finally, it provides a function for handling the action of the form, which only gets call after ALL validation has passed.</p><p>Functions:</p><p>form_init_elements() - This function is used to build the FormElement objects that will be used by the form. This function is called EVERY time the FormContent class is instantiated. After you create the FormElement, you call the FormContent::add_element() method, to add the FormElement object to the form. You will then call the 2 methods FormContent::element_label() and FormContent::element_form() to get access to the FormElement's label and form field respectively.</p><p>form_init_data() - This is called only the first time the form is encountered. It Allows you to populate the FormElements with data from a DB for example. You would use FormContent::set_element_value() or FormContent::set_hidden_element_value() inside here.</p><p>form() - This is the method that gets called to build the layout for your form. Typically you use a table and add the label in the first &lt;td&gt; and the form field itself in the 2nd &lt;td&gt;. So there are 2 methods in the FormContent object that allow u to get access to the FormElements label, and form field. FormContent::element_label() and FormContent::element_form().</p><p>form_backend_validation() - This method enables you to do any &quot;back end&quot; validation of data. Such as, check for a duplicate in the DB on a create/new form. This is called after the FormElement's validation methods have passed.</p><p>form_action() - This method is called after ALL validation was successfull, including each FormElement object's validation methods, as well as the FormContent::form_backend_validation()</p></p>
29 <p class="notes">
30 Located in <a class="field" href="_form_FormContent_inc.html">/form/FormContent.inc</a> (line <span class="field">77</span>)
31 </p>
32
33
34 <pre></pre>
35
36 </div>
37 </div>
38
39 <a name="sec-descendents"></a>
40 <div class="info-box">
41 <div class="info-box-title">Direct descendents</div>
42 <div class="nav-bar">
43 <a href="#sec-description">Description</a> |
44 <span class="disabled">Descendents</span>
45 | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
46 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
47
48 </div>
49 <div class="info-box-body">
50 <table cellpadding="2" cellspacing="0" class="class-table">
51 <tr>
52 <th class="class-table-header">Class</th>
53 <th class="class-table-header">Description</th>
54 </tr>
55 <tr>
56 <td style="padding-right: 2em"><a href="../../phpHtmlLib/form-examples/AccountForm.html">AccountForm</a></td>
57 <td>
58 This is the Class that handles the building of the Form itself. It creates the Form Elements inside the form_init_elements() method.
59 </td>
60 </tr>
61 <tr>
62 <td style="padding-right: 2em"><a href="../../phpHtmlLib/form-examples/SampleForm.html">SampleForm</a></td>
63 <td>
64 This is the Class that handles the building of the Form itself. It creates the Form Elements inside the form_init_elements() method.
65 </td>
66 </tr>
67 <tr>
68 <td style="padding-right: 2em"><a href="../../phpHtmlLib/form-examples/MasterSlaveForm.html">MasterSlaveForm</a></td>
69 <td>
70 This is the Class that handles the building of the Form itself. It creates the Form Elements inside the form_init_elements() method.
71 </td>
72 </tr>
73 <tr>
74 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/StandardFormContent.html">StandardFormContent</a></td>
75 <td>
76 This is a child of the FormContent class to provide a 'standard' look and feel for forms.
77 </td>
78 </tr>
79 </table>
80 </div>
81 </div>
82
83
84 <a name="sec-var-summary"></a>
85 <div class="info-box">
86 <div class="info-box-title">Variable Summary</span></div>
87 <div class="nav-bar">
88 <a href="#sec-description">Description</a> |
89 <a href="#sec-descendents">Descendents</a> |
90 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
91 |
92 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
93
94 </div>
95 <div class="info-box-body">
96 <div class="var-summary">
97 <div class="var-title">
98 <span class="var-type">mixed</span>
99 <a href="#$_action_counter" title="details" class="var-name">$_action_counter</a>
100 </div>
101 <div class="var-title">
102 <span class="var-type">mixed</span>
103 <a href="#$_action_message" title="details" class="var-name">$_action_message</a>
104 </div>
105 <div class="var-title">
106 <span class="var-type">mixed</span>
107 <a href="#$_cancel_action" title="details" class="var-name">$_cancel_action</a>
108 </div>
109 <div class="var-title">
110 <span class="var-type">mixed</span>
111 <a href="#$_default_label_css" title="details" class="var-name">$_default_label_css</a>
112 </div>
113 <div class="var-title">
114 <span class="var-type">mixed</span>
115 <a href="#$_elements" title="details" class="var-name">$_elements</a>
116 </div>
117 <div class="var-title">
118 <span class="var-type">mixed</span>
119 <a href="#$_error_label_css" title="details" class="var-name">$_error_label_css</a>
120 </div>
121 <div class="var-title">
122 <span class="var-type">mixed</span>
123 <a href="#$_file_elements" title="details" class="var-name">$_file_elements</a>
124 </div>
125 <div class="var-title">
126 <span class="var-type">mixed</span>
127 <a href="#$_form_errors_title" title="details" class="var-name">$_form_errors_title</a>
128 </div>
129 <div class="var-title">
130 <span class="var-type">mixed</span>
131 <a href="#$_form_errors_width" title="details" class="var-name">$_form_errors_width</a>
132 </div>
133 <div class="var-title">
134 <span class="var-type">mixed</span>
135 <a href="#$_form_name" title="details" class="var-name">$_form_name</a>
136 </div>
137 <div class="var-title">
138 <span class="var-type">mixed</span>
139 <a href="#$_form_on_submit" title="details" class="var-name">$_form_on_submit</a>
140 </div>
141 <div class="var-title">
142 <span class="var-type">mixed</span>
143 <a href="#$_has_confirm" title="details" class="var-name">$_has_confirm</a>
144 </div>
145 <div class="var-title">
146 <span class="var-type">mixed</span>
147 <a href="#$_has_file_element" title="details" class="var-name">$_has_file_element</a>
148 </div>
149 <div class="var-title">
150 <span class="var-type">mixed</span>
151 <a href="#$_hidden_elements" title="details" class="var-name">$_hidden_elements</a>
152 </div>
153 <div class="var-title">
154 <span class="var-type">mixed</span>
155 <a href="#$_required_field_marker" title="details" class="var-name">$_required_field_marker</a>
156 </div>
157 <div class="var-title">
158 <span class="var-type">mixed</span>
159 <a href="#$_required_field_text" title="details" class="var-name">$_required_field_text</a>
160 </div>
161 <div class="var-title">
162 <span class="var-type">mixed</span>
163 <a href="#$_stripslashes" title="details" class="var-name">$_stripslashes</a>
164 </div>
165 <div class="var-title">
166 <span class="var-type">mixed</span>
167 <a href="#$_width" title="details" class="var-name">$_width</a>
168 </div>
169 </div>
170 </div>
171 </div>
172
173 <a name="sec-method-summary"></a>
174 <div class="info-box">
175 <div class="info-box-title">Method Summary</span></div>
176 <div class="nav-bar">
177 <a href="#sec-description">Description</a> |
178 <a href="#sec-descendents">Descendents</a> |
179 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
180
181 |
182 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
183 </div>
184 <div class="info-box-body">
185 <div class="method-summary">
186
187 <div class="method-definition">
188 <span class="method-result">FormContent</span>
189 <a href="#FormContent" title="details" class="method-name">FormContent</a>
190 ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">"100%"</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$cancel_action</span> = <span class="var-default">NULL</span>])
191 </div>
192
193 <div class="method-definition">
194 <span class="method-result"><a href="../../phpHtmlLib/INPUTtag.html">INPUTtag</a></span>
195 <a href="#add_action" title="details" class="method-name">add_action</a>
196 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$disabled</span> = <span class="var-default">false</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$submit_function</span> = <span class="var-default">false</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$disable_on_submit</span> = <span class="var-default">TRUE</span>])
197 </div>
198
199 <div class="method-definition">
200 <span class="method-result">form</span>
201 <a href="#add_cancel" title="details" class="method-name">add_cancel</a>
202 (<span class="var-type">string</span>&nbsp;<span class="var-name">0</span>)
203 </div>
204
205 <div class="method-definition">
206 <span class="method-result">void</span>
207 <a href="#add_element" title="details" class="method-name">add_element</a>
208 (<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span>&nbsp;<span class="var-name">&$element</span>)
209 </div>
210
211 <div class="method-definition">
212 <span class="method-result">void</span>
213 <a href="#add_error" title="details" class="method-name">add_error</a>
214 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>)
215 </div>
216
217 <div class="method-definition">
218 <span class="method-result"><a href="../../phpHtmlLib/ContainerWidget.html">ContainerWidget</a></span>
219 <a href="#add_hidden_action" title="details" class="method-name">add_hidden_action</a>
220 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$action</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$disable_on_submit</span> = <span class="var-default">TRUE</span>])
221 </div>
222
223 <div class="method-definition">
224 <span class="method-result">void</span>
225 <a href="#add_hidden_element" title="details" class="method-name">add_hidden_element</a>
226 (<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span>&nbsp;<span class="var-name">$label</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">NULL</span>])
227 </div>
228
229 <div class="method-definition">
230 <span class="method-result"><a href="../../phpHtmlLib/Atag.html">Atag</a></span>
231 <a href="#add_image_action" title="details" class="method-name">add_image_action</a>
232 (<span class="var-type">string</span>&nbsp;<span class="var-name">$image_name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$action</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$disable_on_submit</span> = <span class="var-default">TRUE</span>])
233 </div>
234
235 <div class="method-definition">
236 <span class="method-result">void</span>
237 <a href="#build_confirm_table" title="details" class="method-name">build_confirm_table</a>
238 (<span class="var-type"><a href="../../phpHtmlLib/InfoTable.html">InfoTable</a></span>&nbsp;<span class="var-name">&$table</span>)
239 </div>
240
241 <div class="method-definition">
242 <span class="method-result">Object</span>
243 <a href="#element_form" title="details" class="method-name">element_form</a>
244 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>)
245 </div>
246
247 <div class="method-definition">
248 <span class="method-result">Object</span>
249 <a href="#element_label" title="details" class="method-name">element_label</a>
250 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>)
251 </div>
252
253 <div class="method-definition">
254 <span class="method-result"><a href="../../phpHtmlLib/Container.html">Container</a></span>
255 <a href="#form" title="details" class="method-name">form</a>
256 ()
257 </div>
258
259 <div class="method-definition">
260 <span class="method-result">boolean</span>
261 <a href="#form_action" title="details" class="method-name">form_action</a>
262 (<span class="var-type">array</span>&nbsp;<span class="var-name">0</span>)
263 </div>
264
265 <div class="method-definition">
266 <span class="method-result">boolean</span>
267 <a href="#form_backend_validation" title="details" class="method-name">form_backend_validation</a>
268 ()
269 </div>
270
271 <div class="method-definition">
272 <span class="method-result">mixed</span>
273 <a href="#form_confirm" title="details" class="method-name">form_confirm</a>
274 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span> = <span class="var-default">"Form Confirmation"</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$show_buttons</span> = <span class="var-default">TRUE</span>])
275 </div>
276
277 <div class="method-definition">
278 <span class="method-result"><a href="../../phpHtmlLib/TABLEtag.html">TABLEtag</a></span>
279 <a href="#form_errors" title="details" class="method-name">form_errors</a>
280 ()
281 </div>
282
283 <div class="method-definition">
284 <span class="method-result">void</span>
285 <a href="#form_init_data" title="details" class="method-name">form_init_data</a>
286 ()
287 </div>
288
289 <div class="method-definition">
290 <span class="method-result">void</span>
291 <a href="#form_init_elements" title="details" class="method-name">form_init_elements</a>
292 ()
293 </div>
294
295 <div class="method-definition">
296 <span class="method-result">mixed</span>
297 <a href="#form_success" title="details" class="method-name">form_success</a>
298 ()
299 </div>
300
301 <div class="method-definition">
302 <span class="method-result">string</span>
303 <a href="#get_action" title="details" class="method-name">get_action</a>
304 ()
305 </div>
306
307 <div class="method-definition">
308 <span class="method-result">string</span>
309 <a href="#get_default_css" title="details" class="method-name">get_default_css</a>
310 ()
311 </div>
312
313 <div class="method-definition">
314 <span class="method-result">Object</span>
315 <a href="#get_element" title="details" class="method-name">&amp;get_element</a>
316 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>)
317 </div>
318
319 <div class="method-definition">
320 <span class="method-result">value</span>
321 <a href="#get_element_value" title="details" class="method-name">get_element_value</a>
322 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>)
323 </div>
324
325 <div class="method-definition">
326 <span class="method-result">array</span>
327 <a href="#get_error_array" title="details" class="method-name">get_error_array</a>
328 ()
329 </div>
330
331 <div class="method-definition">
332 <span class="method-result">int</span>
333 <a href="#get_form_errors_width" title="details" class="method-name">get_form_errors_width</a>
334 ()
335 </div>
336
337 <div class="method-definition">
338 <span class="method-result">the</span>
339 <a href="#get_form_tabindex" title="details" class="method-name">get_form_tabindex</a>
340 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$index</span>)
341 </div>
342
343 <div class="method-definition">
344 <span class="method-result">value</span>
345 <a href="#get_hidden_element_value" title="details" class="method-name">get_hidden_element_value</a>
346 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>)
347 </div>
348
349 <div class="method-definition">
350 <span class="method-result">boolean</span>
351 <a href="#has_confirm" title="details" class="method-name">has_confirm</a>
352 ()
353 </div>
354
355 <div class="method-definition">
356 <span class="method-result">Object</span>
357 <a href="#hidden_element_label" title="details" class="method-name">hidden_element_label</a>
358 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>)
359 </div>
360
361 <div class="method-definition">
362 <span class="method-result">string</span>
363 <a href="#javascript" title="details" class="method-name">javascript</a>
364 ()
365 </div>
366
367 <div class="method-definition">
368 <span class="method-result">TRUE</span>
369 <a href="#pre_confirm" title="details" class="method-name">pre_confirm</a>
370 ()
371 </div>
372
373 <div class="method-definition">
374 <span class="method-result">void</span>
375 <a href="#set_action" title="details" class="method-name">set_action</a>
376 (<span class="var-type">string</span>&nbsp;<span class="var-name">$action</span>)
377 </div>
378
379 <div class="method-definition">
380 <span class="method-result">void</span>
381 <a href="#set_action_message" title="details" class="method-name">set_action_message</a>
382 (<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>)
383 </div>
384
385 <div class="method-definition">
386 <span class="method-result">void</span>
387 <a href="#set_cancel_action" title="details" class="method-name">set_cancel_action</a>
388 (<span class="var-type">string</span>&nbsp;<span class="var-name">$action</span>)
389 </div>
390
391 <div class="method-definition">
392 <span class="method-result">void</span>
393 <a href="#set_confirm" title="details" class="method-name">set_confirm</a>
394 ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">TRUE</span>])
395 </div>
396
397 <div class="method-definition">
398 <span class="method-result">void</span>
399 <a href="#set_default_css" title="details" class="method-name">set_default_css</a>
400 (<span class="var-type">string</span>&nbsp;<span class="var-name">$css</span>)
401 </div>
402
403 <div class="method-definition">
404 <span class="method-result">void</span>
405 <a href="#set_element_value" title="details" class="method-name">set_element_value</a>
406 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">value</span>&nbsp;<span class="var-name">$value</span>)
407 </div>
408
409 <div class="method-definition">
410 <span class="method-result">void</span>
411 <a href="#set_error_css" title="details" class="method-name">set_error_css</a>
412 (<span class="var-type">string</span>&nbsp;<span class="var-name">$css</span>)
413 </div>
414
415 <div class="method-definition">
416 <span class="method-result">void</span>
417 <a href="#set_form_errors_title" title="details" class="method-name">set_form_errors_title</a>
418 (<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span>)
419 </div>
420
421 <div class="method-definition">
422 <span class="method-result">void</span>
423 <a href="#set_form_errors_width" title="details" class="method-name">set_form_errors_width</a>
424 (<span class="var-type">string</span>&nbsp;<span class="var-name">$width</span>)
425 </div>
426
427 <div class="method-definition">
428 <span class="method-result">void</span>
429 <a href="#set_form_name" title="details" class="method-name">set_form_name</a>
430 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$name</span>)
431 </div>
432
433 <div class="method-definition">
434 <span class="method-result">none</span>
435 <a href="#set_form_tabindex" title="details" class="method-name">set_form_tabindex</a>
436 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$index</span>)
437 </div>
438
439 <div class="method-definition">
440 <span class="method-result">void</span>
441 <a href="#set_form_width" title="details" class="method-name">set_form_width</a>
442 (<span class="var-type">string</span>&nbsp;<span class="var-name">$width</span>)
443 </div>
444
445 <div class="method-definition">
446 <span class="method-result">void</span>
447 <a href="#set_hidden_element_value" title="details" class="method-name">set_hidden_element_value</a>
448 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">value</span>&nbsp;<span class="var-name">$value</span>)
449 </div>
450
451 <div class="method-definition">
452 <span class="method-result">void</span>
453 <a href="#set_required_marker" title="details" class="method-name">set_required_marker</a>
454 (<span class="var-type">string</span>&nbsp;<span class="var-name">$marker</span>)
455 </div>
456
457 <div class="method-definition">
458 <span class="method-result">void</span>
459 <a href="#set_required_text" title="details" class="method-name">set_required_text</a>
460 (<span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>)
461 </div>
462
463 <div class="method-definition">
464 <span class="method-result">void</span>
465 <a href="#set_stripslashes" title="details" class="method-name">set_stripslashes</a>
466 ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">TRUE</span>])
467 </div>
468
469 <div class="method-definition">
470 <span class="method-result">void</span>
471 <a href="#_pre_confirm" title="details" class="method-name">_pre_confirm</a>
472 ()
473 </div>
474
475 <div class="method-definition">
476 <span class="method-result">void</span>
477 <a href="#_test_element" title="details" class="method-name">_test_element</a>
478 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$method</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$hidden</span> = <span class="var-default">FALSE</span>])
479 </div>
480 </div>
481 </div>
482 </div>
483
484 <a name="sec-vars"></a>
485 <div class="info-box">
486 <div class="info-box-title">Variables</div>
487 <div class="nav-bar">
488 <a href="#sec-description">Description</a> |
489 <a href="#sec-descendents">Descendents</a> |
490 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
491
492
493 |
494 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
495
496 </div>
497 <div class="info-box-body">
498 <a name="var$_action_counter" id="$_action_counter"><!-- --></A>
499 <div class="oddrow">
500
501 <div class="var-header">
502 <span class="var-title">
503 <span class="var-type">mixed</span>
504 <span class="var-name">$_action_counter</span>
505 = <span class="var-default"> 0</span> (line <span class="line-number">177</span>)
506 </span>
507 </div>
508
509 <!-- ========== Info from phpDoc block ========= -->
510 <p class="short-description">This holds how many actions we have</p>
511 <p class="description"><p>for this form content</p></p>
512
513
514
515
516
517 </div>
518 <a name="var$_action_message" id="$_action_message"><!-- --></A>
519 <div class="evenrow">
520
521 <div class="var-header">
522 <span class="var-title">
523 <span class="var-type">mixed</span>
524 <span class="var-name">$_action_message</span>
525 = <span class="var-default"> &quot;&quot;</span> (line <span class="line-number">150</span>)
526 </span>
527 </div>
528
529 <!-- ========== Info from phpDoc block ========= -->
530 <p class="short-description">The message that is set</p>
531 <p class="description"><p>during the form_action</p></p>
532
533
534
535
536
537 </div>
538 <a name="var$_cancel_action" id="$_cancel_action"><!-- --></A>
539 <div class="oddrow">
540
541 <div class="var-header">
542 <span class="var-title">
543 <span class="var-type">mixed</span>
544 <span class="var-name">$_cancel_action</span>
545 = <span class="var-default"> NULL</span> (line <span class="line-number">157</span>)
546 </span>
547 </div>
548
549 <!-- ========== Info from phpDoc block ========= -->
550 <p class="short-description">The action to take opon clicking</p>
551 <p class="description"><p>the &quot;Cancel&quot; button</p></p>
552
553
554
555
556
557 </div>
558 <a name="var$_default_label_css" id="$_default_label_css"><!-- --></A>
559 <div class="evenrow">
560
561 <div class="var-header">
562 <span class="var-title">
563 <span class="var-type">mixed</span>
564 <span class="var-name">$_default_label_css</span>
565 = <span class="var-default"> &quot;formlabel&quot;</span> (line <span class="line-number">106</span>)
566 </span>
567 </div>
568
569 <!-- ========== Info from phpDoc block ========= -->
570 <p class="short-description">This holds the default css class for form field label text.</p>
571
572
573
574
575
576 </div>
577 <a name="var$_elements" id="$_elements"><!-- --></A>
578 <div class="oddrow">
579
580 <div class="var-header">
581 <span class="var-title">
582 <span class="var-type">mixed</span>
583 <span class="var-name">$_elements</span>
584 = <span class="var-default">array()</span> (line <span class="line-number">97</span>)
585 </span>
586 </div>
587
588 <!-- ========== Info from phpDoc block ========= -->
589 <p class="short-description">This holds the array of</p>
590 <p class="description"><p>non-hidden elements</p></p>
591
592
593
594
595
596 </div>
597 <a name="var$_error_label_css" id="$_error_label_css"><!-- --></A>
598 <div class="evenrow">
599
600 <div class="var-header">
601 <span class="var-title">
602 <span class="var-type">mixed</span>
603 <span class="var-name">$_error_label_css</span>
604 = <span class="var-default"> &quot;formlabelerror&quot;</span> (line <span class="line-number">113</span>)
605 </span>
606 </div>
607
608 <!-- ========== Info from phpDoc block ========= -->
609 <p class="short-description">This is the css class used</p>
610 <p class="description"><p>for fields that have an error</p></p>
611
612
613
614
615
616 </div>
617 <a name="var$_file_elements" id="$_file_elements"><!-- --></A>
618 <div class="oddrow">
619
620 <div class="var-header">
621 <span class="var-title">
622 <span class="var-type">mixed</span>
623 <span class="var-name">$_file_elements</span>
624 = <span class="var-default">array()</span> (line <span class="line-number">195</span>)
625 </span>
626 </div>
627
628 <!-- ========== Info from phpDoc block ========= -->
629 <p class="short-description">index names of all of the file form elements (if any).</p>
630
631
632
633
634
635 </div>
636 <a name="var$_form_errors_title" id="$_form_errors_title"><!-- --></A>
637 <div class="evenrow">
638
639 <div class="var-header">
640 <span class="var-title">
641 <span class="var-type">mixed</span>
642 <span class="var-name">$_form_errors_title</span>
643 = <span class="var-default"> &quot;Form Errors&quot;</span> (line <span class="line-number">143</span>)
644 </span>
645 </div>
646
647 <!-- ========== Info from phpDoc block ========= -->
648 <p class="short-description">The form errors table title</p>
649
650
651
652
653
654 </div>
655 <a name="var$_form_errors_width" id="$_form_errors_width"><!-- --></A>
656 <div class="oddrow">
657
658 <div class="var-header">
659 <span class="var-title">
660 <span class="var-type">mixed</span>
661 <span class="var-name">$_form_errors_width</span>
662 = <span class="var-default"> null</span> (line <span class="line-number">137</span>)
663 </span>
664 </div>
665
666 <!-- ========== Info from phpDoc block ========= -->
667 <p class="short-description">Holds the width (if any) of the errors table that will be rendered. If the value is null, the $this-&gt;_width value is used instead.</p>
668
669
670
671
672
673 </div>
674 <a name="var$_form_name" id="$_form_name"><!-- --></A>
675 <div class="evenrow">
676
677 <div class="var-header">
678 <span class="var-title">
679 <span class="var-type">mixed</span>
680 <span class="var-name">$_form_name</span>
681 (line <span class="line-number">83</span>)
682 </span>
683 </div>
684
685 <!-- ========== Info from phpDoc block ========= -->
686 <p class="short-description">This holds the name of the form</p>
687 <p class="description"><p>for js that needs it</p></p>
688
689
690
691
692
693 </div>
694 <a name="var$_form_on_submit" id="$_form_on_submit"><!-- --></A>
695 <div class="oddrow">
696
697 <div class="var-header">
698 <span class="var-title">
699 <span class="var-type">mixed</span>
700 <span class="var-name">$_form_on_submit</span>
701 = <span class="var-default"> ''</span> (line <span class="line-number">205</span>)
702 </span>
703 </div>
704
705 <!-- ========== Info from phpDoc block ========= -->
706 <p class="short-description">The onsubmit value for the form</p>
707 <p class="description"><p>tag. FormElement childs can automatically add to this by implementing the form_tag_onsubmit() method</p></p>
708
709
710
711
712
713 </div>
714 <a name="var$_has_confirm" id="$_has_confirm"><!-- --></A>
715 <div class="evenrow">
716
717 <div class="var-header">
718 <span class="var-title">
719 <span class="var-type">mixed</span>
720 <span class="var-name">$_has_confirm</span>
721 = <span class="var-default"> FALSE</span> (line <span class="line-number">120</span>)
722 </span>
723 </div>
724
725 <!-- ========== Info from phpDoc block ========= -->
726 <p class="short-description">flag to let the FormProcessor</p>
727 <p class="description"><p>object know this form has a confirmation page that is required</p></p>
728
729
730
731
732
733 </div>
734 <a name="var$_has_file_element" id="$_has_file_element"><!-- --></A>
735 <div class="oddrow">
736
737 <div class="var-header">
738 <span class="var-title">
739 <span class="var-type">mixed</span>
740 <span class="var-name">$_has_file_element</span>
741 = <span class="var-default"> FALSE</span> (line <span class="line-number">189</span>)
742 </span>
743 </div>
744
745 <!-- ========== Info from phpDoc block ========= -->
746 <p class="short-description">Flag to mark this as having a</p>
747 <p class="description"><p>File Form Element (child of FEFile)</p></p>
748
749
750
751
752
753 </div>
754 <a name="var$_hidden_elements" id="$_hidden_elements"><!-- --></A>
755 <div class="evenrow">
756
757 <div class="var-header">
758 <span class="var-title">
759 <span class="var-type">mixed</span>
760 <span class="var-name">$_hidden_elements</span>
761 = <span class="var-default">array()</span> (line <span class="line-number">91</span>)
762 </span>
763 </div>
764
765 <!-- ========== Info from phpDoc block ========= -->
766 <p class="short-description">This holds the array of</p>
767 <p class="description"><p>hidden form elements used in this form</p></p>
768
769
770
771
772
773 </div>
774 <a name="var$_required_field_marker" id="$_required_field_marker"><!-- --></A>
775 <div class="oddrow">
776
777 <div class="var-header">
778 <span class="var-title">
779 <span class="var-type">mixed</span>
780 <span class="var-name">$_required_field_marker</span>
781 = <span class="var-default"> &quot;*&quot;</span> (line <span class="line-number">171</span>)
782 </span>
783 </div>
784
785 <!-- ========== Info from phpDoc block ========= -->
786 <p class="short-description">marker for the required field</p>
787
788
789
790
791
792 </div>
793 <a name="var$_required_field_text" id="$_required_field_text"><!-- --></A>
794 <div class="evenrow">
795
796 <div class="var-header">
797 <span class="var-title">
798 <span class="var-type">mixed</span>
799 <span class="var-name">$_required_field_text</span>
800 = <span class="var-default"> &quot; - required field&quot;</span> (line <span class="line-number">165</span>)
801 </span>
802 </div>
803
804 <!-- ========== Info from phpDoc block ========= -->
805 <p class="short-description">Text to show denoted required fields for the form.</p>
806
807
808
809
810
811 </div>
812 <a name="var$_stripslashes" id="$_stripslashes"><!-- --></A>
813 <div class="oddrow">
814
815 <div class="var-header">
816 <span class="var-title">
817 <span class="var-type">mixed</span>
818 <span class="var-name">$_stripslashes</span>
819 = <span class="var-default"> FALSE</span> (line <span class="line-number">183</span>)
820 </span>
821 </div>
822
823 <!-- ========== Info from phpDoc block ========= -->
824 <p class="short-description">Automatically strip slashes from</p>
825 <p class="description"><p>form values?</p></p>
826
827
828
829
830
831 </div>
832 <a name="var$_width" id="$_width"><!-- --></A>
833 <div class="evenrow">
834
835 <div class="var-header">
836 <span class="var-title">
837 <span class="var-type">mixed</span>
838 <span class="var-name">$_width</span>
839 = <span class="var-default"> &quot;600&quot;</span> (line <span class="line-number">129</span>)
840 </span>
841 </div>
842
843 <!-- ========== Info from phpDoc block ========= -->
844 <p class="short-description">Holds the width to be used for the</p>
845 <p class="description"><p>error table DEFAULT: 95%</p></p>
846
847
848
849
850
851 </div>
852
853
854 </div>
855 </div>
856
857 <a name="sec-methods"></a>
858 <div class="info-box">
859 <div class="info-box-title">Methods</div>
860 <div class="nav-bar">
861 <a href="#sec-description">Description</a> |
862 <a href="#sec-descendents">Descendents</a> |
863 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
864 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
865
866 </div>
867 <div class="info-box-body">
868 <A NAME='method_detail'></A>
869 <a name="methodFormContent" id="FormContent"><!-- --></a>
870 <div class="oddrow">
871
872 <div class="method-header">
873 <span class="method-title">Constructor FormContent</span> (line <span class="line-number">208</span>)
874 </div>
875
876 <!-- ========== Info from phpDoc block ========= -->
877
878 <div class="method-signature">
879 <span class="method-result">FormContent</span>
880 <span class="method-name">
881 FormContent
882 </span>
883 ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">"100%"</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$cancel_action</span> = <span class="var-default">NULL</span>])
884 </div>
885
886
887
888 </div>
889 <a name="methodadd_action" id="add_action"><!-- --></a>
890 <div class="evenrow">
891
892 <div class="method-header">
893 <span class="method-title">add_action</span> (line <span class="line-number">855</span>)
894 </div>
895
896 <!-- ========== Info from phpDoc block ========= -->
897 <p class="short-description">This function adds a form submit button with the appropriate action.</p>
898 <ul class="tags">
899 <li><span class="field">return:</span> object</li>
900 </ul>
901
902 <div class="method-signature">
903 <span class="method-result"><a href="../../phpHtmlLib/INPUTtag.html">INPUTtag</a></span>
904 <span class="method-name">
905 add_action
906 </span>
907 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$disabled</span> = <span class="var-default">false</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$submit_function</span> = <span class="var-default">false</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$disable_on_submit</span> = <span class="var-default">TRUE</span>])
908 </div>
909
910 <ul class="parameters">
911 <li>
912 <span class="var-type">string</span>
913 <span class="var-name">$label</span><span class="var-description">: - the labe/action for the submit button.</span> </li>
914 <li>
915 <span class="var-type">bool</span>
916 <span class="var-name">$disabled</span><span class="var-description">: disable the button</span> </li>
917 <li>
918 <span class="var-type">string</span>
919 <span class="var-name">$submit_function</span><span class="var-description">: - the onSubmit function (if any)</span> </li>
920 <li>
921 <span class="var-type">boolean</span>
922 <span class="var-name">$disable_on_submit</span><span class="var-description">: - disable opon submit?</span> </li>
923 </ul>
924
925
926 </div>
927 <a name="methodadd_cancel" id="add_cancel"><!-- --></a>
928 <div class="oddrow">
929
930 <div class="method-header">
931 <span class="method-title">add_cancel</span> (line <span class="line-number">978</span>)
932 </div>
933
934 <!-- ========== Info from phpDoc block ========= -->
935 <p class="short-description">build a cancel button with a url to go to</p>
936 <ul class="tags">
937 <li><span class="field">return:</span> button</li>
938 </ul>
939
940 <div class="method-signature">
941 <span class="method-result">form</span>
942 <span class="method-name">
943 add_cancel
944 </span>
945 (<span class="var-type">string</span>&nbsp;<span class="var-name">0</span>)
946 </div>
947
948 <ul class="parameters">
949 <li>
950 <span class="var-type">string</span>
951 <span class="var-name">0</span><span class="var-description">: - the cancel action</span> </li>
952 </ul>
953
954
955 </div>
956 <a name="methodadd_element" id="add_element"><!-- --></a>
957 <div class="evenrow">
958
959 <div class="method-header">
960 <span class="method-title">add_element</span> (line <span class="line-number">487</span>)
961 </div>
962
963 <!-- ========== Info from phpDoc block ========= -->
964 <p class="short-description">This method is used to add a form element</p>
965
966 <div class="method-signature">
967 <span class="method-result">void</span>
968 <span class="method-name">
969 add_element
970 </span>
971 (<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span>&nbsp;<span class="var-name">&$element</span>)
972 </div>
973
974 <ul class="parameters">
975 <li>
976 <span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span>
977 <span class="var-name">&$element</span><span class="var-description">: object</span> </li>
978 </ul>
979
980
981 </div>
982 <a name="methodadd_error" id="add_error"><!-- --></a>
983 <div class="oddrow">
984
985 <div class="method-header">
986 <span class="method-title">add_error</span> (line <span class="line-number">652</span>)
987 </div>
988
989 <!-- ========== Info from phpDoc block ========= -->
990 <p class="short-description">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.</p>
991
992 <div class="method-signature">
993 <span class="method-result">void</span>
994 <span class="method-name">
995 add_error
996 </span>
997 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>)
998 </div>
999
1000 <ul class="parameters">
1001 <li>
1002 <span class="var-type">string</span>
1003 <span class="var-name">$label</span><span class="var-description">: - the label</span> </li>
1004 <li>
1005 <span class="var-type">string</span>
1006 <span class="var-name">$message</span><span class="var-description">: - the error message</span> </li>
1007 </ul>
1008
1009
1010 </div>
1011 <a name="methodadd_hidden_action" id="add_hidden_action"><!-- --></a>
1012 <div class="evenrow">
1013
1014 <div class="method-header">
1015 <span class="method-title">add_hidden_action</span> (line <span class="line-number">907</span>)
1016 </div>
1017
1018 <!-- ========== Info from phpDoc block ========= -->
1019 <p class="short-description">This function adds a submit button that can have any label. It just makes the _form_action a hidden field.</p>
1020 <p class="description"><p>NOTE: you can only do this ONCE per form.</p></p>
1021 <ul class="tags">
1022 <li><span class="field">return:</span> object</li>
1023 </ul>
1024
1025 <div class="method-signature">
1026 <span class="method-result"><a href="../../phpHtmlLib/ContainerWidget.html">ContainerWidget</a></span>
1027 <span class="method-name">
1028 add_hidden_action
1029 </span>
1030 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$action</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$disable_on_submit</span> = <span class="var-default">TRUE</span>])
1031 </div>
1032
1033 <ul class="parameters">
1034 <li>
1035 <span class="var-type">string</span>
1036 <span class="var-name">$label</span><span class="var-description">: - the label of the button.</span> </li>
1037 <li>
1038 <span class="var-type">string</span>
1039 <span class="var-name">$action</span><span class="var-description">: - the action value.</span> </li>
1040 <li>
1041 <span class="var-type">boolean</span>
1042 <span class="var-name">$disable_on_submit</span><span class="var-description">: - disable opon submit?</span> </li>
1043 </ul>
1044
1045
1046 </div>
1047 <a name="methodadd_hidden_element" id="add_hidden_element"><!-- --></a>
1048 <div class="oddrow">
1049
1050 <div class="method-header">
1051 <span class="method-title">add_hidden_element</span> (line <span class="line-number">510</span>)
1052 </div>
1053
1054 <!-- ========== Info from phpDoc block ========= -->
1055 <p class="short-description">This method is used to add a hidden form field</p>
1056
1057 <div class="method-signature">
1058 <span class="method-result">void</span>
1059 <span class="method-name">
1060 add_hidden_element
1061 </span>
1062 (<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span>&nbsp;<span class="var-name">$label</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">NULL</span>])
1063 </div>
1064
1065 <ul class="parameters">
1066 <li>
1067 <span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span>
1068 <span class="var-name">$label</span><span class="var-description">: object</span> </li>
1069 </ul>
1070
1071
1072 </div>
1073 <a name="methodadd_image_action" id="add_image_action"><!-- --></a>
1074 <div class="evenrow">
1075
1076 <div class="method-header">
1077 <span class="method-title">add_image_action</span> (line <span class="line-number">944</span>)
1078 </div>
1079
1080 <!-- ========== Info from phpDoc block ========= -->
1081 <p class="short-description">This function adds an action as an image to submit the form.</p>
1082 <ul class="tags">
1083 <li><span class="field">return:</span> object</li>
1084 </ul>
1085
1086 <div class="method-signature">
1087 <span class="method-result"><a href="../../phpHtmlLib/Atag.html">Atag</a></span>
1088 <span class="method-name">
1089 add_image_action
1090 </span>
1091 (<span class="var-type">string</span>&nbsp;<span class="var-name">$image_name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$action</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$disable_on_submit</span> = <span class="var-default">TRUE</span>])
1092 </div>
1093
1094 <ul class="parameters">
1095 <li>
1096 <span class="var-type">string</span>
1097 <span class="var-name">$image_name</span><span class="var-description">: - the image name path</span> </li>
1098 <li>
1099 <span class="var-type">string</span>
1100 <span class="var-name">$action</span><span class="var-description">: - the action</span> </li>
1101 <li>
1102 <span class="var-type">boolean</span>
1103 <span class="var-name">$disable_on_submit</span><span class="var-description">: - disable opon submit?</span> </li>
1104 </ul>
1105
1106
1107 </div>
1108 <a name="methodbuild_confirm_table" id="build_confirm_table"><!-- --></a>
1109 <div class="oddrow">
1110
1111 <div class="method-header">
1112 <span class="method-title">build_confirm_table</span> (line <span class="line-number">347</span>)
1113 </div>
1114
1115 <!-- ========== Info from phpDoc block ========= -->
1116 <p class="short-description">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.</p>
1117
1118 <div class="method-signature">
1119 <span class="method-result">void</span>
1120 <span class="method-name">
1121 build_confirm_table
1122 </span>
1123 (<span class="var-type"><a href="../../phpHtmlLib/InfoTable.html">InfoTable</a></span>&nbsp;<span class="var-name">&$table</span>)
1124 </div>
1125
1126 <ul class="parameters">
1127 <li>
1128 <span class="var-type"><a href="../../phpHtmlLib/InfoTable.html">InfoTable</a></span>
1129 <span class="var-name">&$table</span><span class="var-description">: object</span> </li>
1130 </ul>
1131
1132
1133 </div>
1134 <a name="methodelement_form" id="element_form"><!-- --></a>
1135 <div class="evenrow">
1136
1137 <div class="method-header">
1138 <span class="method-title">element_form</span> (line <span class="line-number">548</span>)
1139 </div>
1140
1141 <!-- ========== Info from phpDoc block ========= -->
1142 <p class="short-description">This method returns the actual form object that renders the form field.</p>
1143 <p class="description"><p>Such as an INPUTtag object.</p></p>
1144
1145 <div class="method-signature">
1146 <span class="method-result">Object</span>
1147 <span class="method-name">
1148 element_form
1149 </span>
1150 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>)
1151 </div>
1152
1153 <ul class="parameters">
1154 <li>
1155 <span class="var-type">string</span>
1156 <span class="var-name">$label</span><span class="var-description">: - the element's label</span> </li>
1157 </ul>
1158
1159
1160 </div>
1161 <a name="methodelement_label" id="element_label"><!-- --></a>
1162 <div class="oddrow">
1163
1164 <div class="method-header">
1165 <span class="method-title">element_label</span> (line <span class="line-number">523</span>)
1166 </div>
1167
1168 <!-- ========== Info from phpDoc block ========= -->
1169 <p class="short-description">This method returns the label object for a visible form element.</p>
1170
1171 <div class="method-signature">
1172 <span class="method-result">Object</span>
1173 <span class="method-name">
1174 element_label
1175 </span>
1176 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>)
1177 </div>
1178
1179 <ul class="parameters">
1180 <li>
1181 <span class="var-type">string</span>
1182 <span class="var-name">$label</span><span class="var-description">: - the element's label</span> </li>
1183 </ul>
1184
1185
1186 </div>
1187 <a name="methodform" id="form"><!-- --></a>
1188 <div class="evenrow">
1189
1190 <div class="method-header">
1191 <span class="method-title">form</span> (line <span class="line-number">252</span>)
1192 </div>
1193
1194 <!-- ========== Info from phpDoc block ========= -->
1195 <p class="short-description">This method builds the html form.</p>
1196 <p class="description"><p>It is up to the child class to define the layout of the form and return it in a phpHtmllib container.</p></p>
1197
1198 <div class="method-signature">
1199 <span class="method-result"><a href="../../phpHtmlLib/Container.html">Container</a></span>
1200 <span class="method-name">
1201 form
1202 </span>
1203 ()
1204 </div>
1205
1206
1207
1208 <hr class="separator" />
1209 <div class="notes">Redefined in descendants as:</div>
1210 <ul class="redefinitions">
1211 <li>
1212 <a href="../../phpHtmlLib/form-examples/AccountForm.html#methodform">AccountForm::form()</a>
1213 : This is the method that builds the layout of where the FormElements will live. You can lay it out any way you like.
1214 </li>
1215 <li>
1216 <a href="../../phpHtmlLib/form-examples/SampleForm.html#methodform">SampleForm::form()</a>
1217 : This is the method that builds the layout of where the FormElements will live. You can lay it out any way you like.
1218 </li>
1219 <li>
1220 <a href="../../phpHtmlLib/form-examples/MasterSlaveForm.html#methodform">MasterSlaveForm::form()</a>
1221 : This is the method that builds the layout of where the FormElements will live. You can lay it out any way you like.
1222 </li>
1223 <li>
1224 <a href="../../phpHtmlLib/FormProcessing/StandardFormContent.html#methodform">StandardFormContent::form()</a>
1225 : this builds the main wrapper for the form fields and ads the Save and Cancel buttons
1226 </li>
1227 </ul>
1228 </div>
1229 <a name="methodform_action" id="form_action"><!-- --></a>
1230 <div class="oddrow">
1231
1232 <div class="method-header">
1233 <span class="method-title">form_action</span> (line <span class="line-number">400</span>)
1234 </div>
1235
1236 <!-- ========== Info from phpDoc block ========= -->
1237 <p class="short-description">This method handles the</p>
1238 <p class="description"><p>action (submit button) that was submitted. This method only gets called AFTER all data has been validated. This includes the backend validation. If the form has the confirmation on, then this method will be called after the confirmation has been accepted.</p><p>NOTE : return TRUE if the action was succesfully handled. If FALSE is returned, the form will be displayed again with the error message.</p></p>
1239 <ul class="tags">
1240 <li><span class="field">return:</span> TRUE = success FALSE = failed.</li>
1241 </ul>
1242
1243 <div class="method-signature">
1244 <span class="method-result">boolean</span>
1245 <span class="method-name">
1246 form_action
1247 </span>
1248 (<span class="var-type">array</span>&nbsp;<span class="var-name">0</span>)
1249 </div>
1250
1251 <ul class="parameters">
1252 <li>
1253 <span class="var-type">array</span>
1254 <span class="var-name">0</span><span class="var-description">: - array of errors if any</span> </li>
1255 </ul>
1256
1257
1258 <hr class="separator" />
1259 <div class="notes">Redefined in descendants as:</div>
1260 <ul class="redefinitions">
1261 <li>
1262 <a href="../../phpHtmlLib/form-examples/AccountForm.html#methodform_action">AccountForm::form_action()</a>
1263 : This method is called ONLY after ALL validation has passed. This is the method that allows you to do something with the data, say insert/update records in the DB.
1264 </li>
1265 <li>
1266 <a href="../../phpHtmlLib/form-examples/SampleForm.html#methodform_action">SampleForm::form_action()</a>
1267 : This method is called ONLY after ALL validation has passed. This is the method that allows you to do something with the data, say insert/update records in the DB.
1268 </li>
1269 <li>
1270 <a href="../../phpHtmlLib/form-examples/MasterSlaveForm.html#methodform_action">MasterSlaveForm::form_action()</a>
1271 : This method is called ONLY after ALL validation has passed. This is the method that allows you to do something with the data, say insert/update records in the DB.
1272 </li>
1273 <li>
1274 <a href="../../phpHtmlLib/FormProcessing/StandardFormContent.html#methodform_action">StandardFormContent::form_action()</a>
1275 : This method handles the form action.
1276 </li>
1277 </ul>
1278 </div>
1279 <a name="methodform_backend_validation" id="form_backend_validation"><!-- --></a>
1280 <div class="evenrow">
1281
1282 <div class="method-header">
1283 <span class="method-title">form_backend_validation</span> (line <span class="line-number">372</span>)
1284 </div>
1285
1286 <!-- ========== Info from phpDoc block ========= -->
1287 <p class="short-description">This method is called after the FormElements</p>
1288 <p class="description"><p>have all been validated, and the form_confirm has been confirmed. It enables the form to validate any data against a DB or other backend processing. This will always get called before the form_action method is called to ensure that all form data is valid before form_action() is called.</p></p>
1289 <ul class="tags">
1290 <li><span class="field">return:</span> TRUE if successfull FALSE if errors were detected.</li>
1291 </ul>
1292
1293 <div class="method-signature">
1294 <span class="method-result">boolean</span>
1295 <span class="method-name">
1296 form_backend_validation
1297 </span>
1298 ()
1299 </div>
1300
1301
1302
1303 <hr class="separator" />
1304 <div class="notes">Redefined in descendants as:</div>
1305 <ul class="redefinitions">
1306 <li>
1307 <a href="../../phpHtmlLib/form-examples/AccountForm.html#methodform_backend_validation">AccountForm::form_backend_validation()</a>
1308 : This method gets called after the FormElement data has passed the validation. This enables you to validate the data against some backend mechanism, say a DB.
1309 </li>
1310 <li>
1311 <a href="../../phpHtmlLib/form-examples/SampleForm.html#methodform_backend_validation">SampleForm::form_backend_validation()</a>
1312 : This method gets called after the FormElement data has passed the validation. This enables you to validate the data against some backend mechanism, say a DB.
1313 </li>
1314 <li>
1315 <a href="../../phpHtmlLib/form-examples/Step1.html#methodform_backend_validation">Step1::form_backend_validation()</a>
1316 : 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.
1317 </li>
1318 <li>
1319 <a href="../../phpHtmlLib/form-examples/StandardAccountForm.html#methodform_backend_validation">StandardAccountForm::form_backend_validation()</a>
1320 : 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.
1321 </li>
1322 </ul>
1323 </div>
1324 <a name="methodform_confirm" id="form_confirm"><!-- --></a>
1325 <div class="oddrow">
1326
1327 <div class="method-header">
1328 <span class="method-title">form_confirm</span> (line <span class="line-number">316</span>)
1329 </div>
1330
1331 <!-- ========== Info from phpDoc block ========= -->
1332 <p class="short-description">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.</p>
1333 <p class="description"><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></p>
1334 <ul class="tags">
1335 <li><span class="field">return:</span> - either raw html, or some container HTMLTag object.</li>
1336 </ul>
1337
1338 <div class="method-signature">
1339 <span class="method-result">mixed</span>
1340 <span class="method-name">
1341 form_confirm
1342 </span>
1343 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span> = <span class="var-default">"Form Confirmation"</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$show_buttons</span> = <span class="var-default">TRUE</span>])
1344 </div>
1345
1346 <ul class="parameters">
1347 <li>
1348 <span class="var-type">string</span>
1349 <span class="var-name">$title</span><span class="var-description">: - the title for the table</span> </li>
1350 <li>
1351 <span class="var-type">boolean</span>
1352 <span class="var-name">$show_buttons</span><span class="var-description">: - show the action buttons?</span> </li>
1353 </ul>
1354
1355
1356 <hr class="separator" />
1357 <div class="notes">Redefined in descendants as:</div>
1358 <ul class="redefinitions">
1359 <li>
1360 <a href="../../phpHtmlLib/FormProcessing/StandardFormContent.html#methodform_confirm">StandardFormContent::form_confirm()</a>
1361 : 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.
1362 </li>
1363 </ul>
1364 </div>
1365 <a name="methodform_errors" id="form_errors"><!-- --></a>
1366 <div class="evenrow">
1367
1368 <div class="method-header">
1369 <span class="method-title">form_errors</span> (line <span class="line-number">431</span>)
1370 </div>
1371
1372 <!-- ========== Info from phpDoc block ========= -->
1373 <p class="short-description">This function is used to render the error table for the form. The error data comes from the FormProcessor or the FormValidation.</p>
1374 <p class="description"><p>NOTE: You can override this method to show a customized error message(s)</p></p>
1375 <ul class="tags">
1376 <li><span class="field">return:</span> object.</li>
1377 </ul>
1378
1379 <div class="method-signature">
1380 <span class="method-result"><a href="../../phpHtmlLib/TABLEtag.html">TABLEtag</a></span>
1381 <span class="method-name">
1382 form_errors
1383 </span>
1384 ()
1385 </div>
1386
1387
1388
1389 </div>
1390 <a name="methodform_init_data" id="form_init_data"><!-- --></a>
1391 <div class="oddrow">
1392
1393 <div class="method-header">
1394 <span class="method-title">form_init_data</span> (line <span class="line-number">239</span>)
1395 </div>
1396
1397 <!-- ========== Info from phpDoc block ========= -->
1398 <p class="short-description">This method is called by the</p>
1399 <p class="description"><p>Form Processor to allow this class to do any fetching of data to prepopulate the form field values. You typically use this to read data from a DB.</p><p>This method is only called once when the form is first hit.</p><p>NOTE: you should build the data and save it in $this-&gt;_init_data</p></p>
1400
1401 <div class="method-signature">
1402 <span class="method-result">void</span>
1403 <span class="method-name">
1404 form_init_data
1405 </span>
1406 ()
1407 </div>
1408
1409
1410
1411 <hr class="separator" />
1412 <div class="notes">Redefined in descendants as:</div>
1413 <ul class="redefinitions">
1414 <li>
1415 <a href="../../phpHtmlLib/form-examples/AccountForm.html#methodform_init_data">AccountForm::form_init_data()</a>
1416 : This method is called only the first time the form page is hit. This enables u to query a DB and pre populate the FormElement objects with data.
1417 </li>
1418 <li>
1419 <a href="../../phpHtmlLib/form-examples/SampleForm.html#methodform_init_data">SampleForm::form_init_data()</a>
1420 : This method is called only the first time the form page is hit. This enables u to query a DB and pre populate the FormElement objects with data.
1421 </li>
1422 <li>
1423 <a href="../../phpHtmlLib/form-examples/MasterSlaveForm.html#methodform_init_data">MasterSlaveForm::form_init_data()</a>
1424 : This method is called only the first time the form page is hit. This enables u to query a DB and pre populate the FormElement objects with data.
1425 </li>
1426 <li>
1427 <a href="../../phpHtmlLib/form-examples/Step1.html#methodform_init_data">Step1::form_init_data()</a>
1428 : This method is called only the first time the form page is hit.
1429 </li>
1430 <li>
1431 <a href="../../phpHtmlLib/form-examples/Step2.html#methodform_init_data">Step2::form_init_data()</a>
1432 : This method is called only the first time the form page is hit.
1433 </li>
1434 <li>
1435 <a href="../../phpHtmlLib/form-examples/Step3.html#methodform_init_data">Step3::form_init_data()</a>
1436 : This method is called only the first time the form page is hit.
1437 </li>
1438 <li>
1439 <a href="../../phpHtmlLib/form-examples/StandardAccountForm.html#methodform_init_data">StandardAccountForm::form_init_data()</a>
1440 : This method is called only the first time the form page is hit.
1441 </li>
1442 </ul>
1443 </div>
1444 <a name="methodform_init_elements" id="form_init_elements"><!-- --></a>
1445 <div class="evenrow">
1446
1447 <div class="method-header">
1448 <span class="method-title">form_init_elements</span> (line <span class="line-number">219</span>)
1449 </div>
1450
1451 <!-- ========== Info from phpDoc block ========= -->
1452 <p class="short-description">This method is what is called to build the list of FormElements that will be used by this form.</p>
1453
1454 <div class="method-signature">
1455 <span class="method-result">void</span>
1456 <span class="method-name">
1457 form_init_elements
1458 </span>
1459 ()
1460 </div>
1461
1462
1463
1464 <hr class="separator" />
1465 <div class="notes">Redefined in descendants as:</div>
1466 <ul class="redefinitions">
1467 <li>
1468 <a href="../../phpHtmlLib/form-examples/AccountForm.html#methodform_init_elements">AccountForm::form_init_elements()</a>
1469 : This method gets called EVERY time the object is created. It is used to build all of the FormElement objects used in this Form.
1470 </li>
1471 <li>
1472 <a href="../../phpHtmlLib/form-examples/SampleForm.html#methodform_init_elements">SampleForm::form_init_elements()</a>
1473 : This method gets called EVERY time the object is created. It is used to build all of the FormElement objects used in this Form.
1474 </li>
1475 <li>
1476 <a href="../../phpHtmlLib/form-examples/MasterSlaveForm.html#methodform_init_elements">MasterSlaveForm::form_init_elements()</a>
1477 : This method gets called EVERY time the object is created. It is used to build all of the FormElement objects used in this Form.
1478 </li>
1479 <li>
1480 <a href="../../phpHtmlLib/form-examples/Step1.html#methodform_init_elements">Step1::form_init_elements()</a>
1481 : This method gets called EVERY time the object is
1482 </li>
1483 <li>
1484 <a href="../../phpHtmlLib/form-examples/Step2.html#methodform_init_elements">Step2::form_init_elements()</a>
1485 : This method gets called EVERY time the object is
1486 </li>
1487 <li>
1488 <a href="../../phpHtmlLib/form-examples/Step3.html#methodform_init_elements">Step3::form_init_elements()</a>
1489 : This method gets called EVERY time the object is
1490 </li>
1491 <li>
1492 <a href="../../phpHtmlLib/form-examples/StandardAccountForm.html#methodform_init_elements">StandardAccountForm::form_init_elements()</a>
1493 : This method gets called EVERY time the object is
1494 </li>
1495 </ul>
1496 </div>
1497 <a name="methodform_success" id="form_success"><!-- --></a>
1498 <div class="oddrow">
1499
1500 <div class="method-header">
1501 <span class="method-title">form_success</span> (line <span class="line-number">414</span>)
1502 </div>
1503
1504 <!-- ========== Info from phpDoc block ========= -->
1505 <p class="short-description">This method is called when the form_action() was successfull, and the form wants to render some kind of message</p>
1506
1507 <div class="method-signature">
1508 <span class="method-result">mixed</span>
1509 <span class="method-name">
1510 form_success
1511 </span>
1512 ()
1513 </div>
1514
1515
1516
1517 </div>
1518 <a name="methodget_action" id="get_action"><!-- --></a>
1519 <div class="evenrow">
1520
1521 <div class="method-header">
1522 <span class="method-title">get_action</span> (line <span class="line-number">685</span>)
1523 </div>
1524
1525 <!-- ========== Info from phpDoc block ========= -->
1526 <p class="short-description">Get the current status of the action.</p>
1527
1528 <div class="method-signature">
1529 <span class="method-result">string</span>
1530 <span class="method-name">
1531 get_action
1532 </span>
1533 ()
1534 </div>
1535
1536
1537
1538 </div>
1539 <a name="methodget_default_css" id="get_default_css"><!-- --></a>
1540 <div class="oddrow">
1541
1542 <div class="method-header">
1543 <span class="method-title">get_default_css</span> (line <span class="line-number">760</span>)
1544 </div>
1545
1546 <!-- ========== Info from phpDoc block ========= -->
1547 <p class="short-description">This function returns the default css class used for NON error text.</p>
1548 <ul class="tags">
1549 <li><span class="field">return:</span> - the current default css</li>
1550 </ul>
1551
1552 <div class="method-signature">
1553 <span class="method-result">string</span>
1554 <span class="method-name">
1555 get_default_css
1556 </span>
1557 ()
1558 </div>
1559
1560
1561
1562 </div>
1563 <a name="methodget_element" id="get_element"><!-- --></a>
1564 <div class="evenrow">
1565
1566 <div class="method-header">
1567 <span class="method-title">get_element</span> (line <span class="line-number">560</span>)
1568 </div>
1569
1570 <!-- ========== Info from phpDoc block ========= -->
1571 <p class="short-description">This method returns the FormElement based on the label.</p>
1572
1573 <div class="method-signature">
1574 <span class="method-result">Object</span>
1575 <span class="method-name">
1576 &amp;get_element
1577 </span>
1578 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>)
1579 </div>
1580
1581 <ul class="parameters">
1582 <li>
1583 <span class="var-type">string</span>
1584 <span class="var-name">$label</span><span class="var-description">: - the element's label</span> </li>
1585 </ul>
1586
1587
1588 </div>
1589 <a name="methodget_element_value" id="get_element_value"><!-- --></a>
1590 <div class="oddrow">
1591
1592 <div class="method-header">
1593 <span class="method-title">get_element_value</span> (line <span class="line-number">586</span>)
1594 </div>
1595
1596 <!-- ========== Info from phpDoc block ========= -->
1597 <p class="short-description">This method is used to get the value for a non hidden element</p>
1598 <ul class="tags">
1599 <li><span class="field">return:</span> - the new value</li>
1600 </ul>
1601
1602 <div class="method-signature">
1603 <span class="method-result">value</span>
1604 <span class="method-name">
1605 get_element_value
1606 </span>
1607 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>)
1608 </div>
1609
1610 <ul class="parameters">
1611 <li>
1612 <span class="var-type">string</span>
1613 <span class="var-name">$label</span><span class="var-description">: - the form label</span> </li>
1614 </ul>
1615
1616
1617 </div>
1618 <a name="methodget_error_array" id="get_error_array"><!-- --></a>
1619 <div class="evenrow">
1620
1621 <div class="method-header">
1622 <span class="method-title">get_error_array</span> (line <span class="line-number">462</span>)
1623 </div>
1624
1625 <!-- ========== Info from phpDoc block ========= -->
1626 <p class="short-description">This method returns an array of errors for all the errors.</p>
1627
1628 <div class="method-signature">
1629 <span class="method-result">array</span>
1630 <span class="method-name">
1631 get_error_array
1632 </span>
1633 ()
1634 </div>
1635
1636
1637
1638 </div>
1639 <a name="methodget_form_errors_width" id="get_form_errors_width"><!-- --></a>
1640 <div class="oddrow">
1641
1642 <div class="method-header">
1643 <span class="method-title">get_form_errors_width</span> (line <span class="line-number">707</span>)
1644 </div>
1645
1646 <!-- ========== Info from phpDoc block ========= -->
1647 <p class="short-description">This method returns the width of the form errors table.</p>
1648 <p class="description"><p>By default it is supposed to be the same width as the form itself.</p></p>
1649
1650 <div class="method-signature">
1651 <span class="method-result">int</span>
1652 <span class="method-name">
1653 get_form_errors_width
1654 </span>
1655 ()
1656 </div>
1657
1658
1659
1660 </div>
1661 <a name="methodget_form_tabindex" id="get_form_tabindex"><!-- --></a>
1662 <div class="evenrow">
1663
1664 <div class="method-header">
1665 <span class="method-title">get_form_tabindex</span> (line <span class="line-number">636</span>)
1666 </div>
1667
1668 <!-- ========== Info from phpDoc block ========= -->
1669 <p class="short-description">This method is a helper method to get the FormElement's tabindex.</p>
1670 <ul class="tags">
1671 <li><span class="field">return:</span> FormElement's current tabindex</li>
1672 </ul>
1673
1674 <div class="method-signature">
1675 <span class="method-result">the</span>
1676 <span class="method-name">
1677 get_form_tabindex
1678 </span>
1679 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$index</span>)
1680 </div>
1681
1682 <ul class="parameters">
1683 <li>
1684 <span class="var-type">string</span>
1685 <span class="var-name">$label</span><span class="var-description">: - the form label</span> </li>
1686 <li>
1687 <span class="var-type">int</span>
1688 <span class="var-name">$index</span><span class="var-description">: - the FormElement's tabindex</span> </li>
1689 </ul>
1690
1691
1692 </div>
1693 <a name="methodget_hidden_element_value" id="get_hidden_element_value"><!-- --></a>
1694 <div class="oddrow">
1695
1696 <div class="method-header">
1697 <span class="method-title">get_hidden_element_value</span> (line <span class="line-number">610</span>)
1698 </div>
1699
1700 <!-- ========== Info from phpDoc block ========= -->
1701 <p class="short-description">This method is used to get the value for a hidden element</p>
1702 <ul class="tags">
1703 <li><span class="field">return:</span> - the new value</li>
1704 </ul>
1705
1706 <div class="method-signature">
1707 <span class="method-result">value</span>
1708 <span class="method-name">
1709 get_hidden_element_value
1710 </span>
1711 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>)
1712 </div>
1713
1714 <ul class="parameters">
1715 <li>
1716 <span class="var-type">string</span>
1717 <span class="var-name">$label</span><span class="var-description">: - the form label</span> </li>
1718 </ul>
1719
1720
1721 </div>
1722 <a name="methodhas_confirm" id="has_confirm"><!-- --></a>
1723 <div class="evenrow">
1724
1725 <div class="method-header">
1726 <span class="method-title">has_confirm</span> (line <span class="line-number">800</span>)
1727 </div>
1728
1729 <!-- ========== Info from phpDoc block ========= -->
1730 <p class="short-description">This gets the value of the confirmation flag.</p>
1731 <p class="description"><p>which tells the caller that this object has/doesn't have a required confirmation page.</p></p>
1732
1733 <div class="method-signature">
1734 <span class="method-result">boolean</span>
1735 <span class="method-name">
1736 has_confirm
1737 </span>
1738 ()
1739 </div>
1740
1741
1742
1743 </div>
1744 <a name="methodhidden_element_label" id="hidden_element_label"><!-- --></a>
1745 <div class="oddrow">
1746
1747 <div class="method-header">
1748 <span class="method-title">hidden_element_label</span> (line <span class="line-number">535</span>)
1749 </div>
1750
1751 <!-- ========== Info from phpDoc block ========= -->
1752 <p class="short-description">This method returns the label object for a visible form element.</p>
1753
1754 <div class="method-signature">
1755 <span class="method-result">Object</span>
1756 <span class="method-name">
1757 hidden_element_label
1758 </span>
1759 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>)
1760 </div>
1761
1762 <ul class="parameters">
1763 <li>
1764 <span class="var-type">string</span>
1765 <span class="var-name">$label</span><span class="var-description">: - the element's label</span> </li>
1766 </ul>
1767
1768
1769 </div>
1770 <a name="methodjavascript" id="javascript"><!-- --></a>
1771 <div class="evenrow">
1772
1773 <div class="method-header">
1774 <span class="method-title">javascript</span> (line <span class="line-number">265</span>)
1775 </div>
1776
1777 <!-- ========== Info from phpDoc block ========= -->
1778 <p class="short-description">This method lets you provide any javascript that is associated with the form content.</p>
1779 <p class="description"><p>The FormProcessor will automatically call this and wrap it in a script tag.</p></p>
1780 <ul class="tags">
1781 <li><span class="field">return:</span> - raw js.</li>
1782 </ul>
1783
1784 <div class="method-signature">
1785 <span class="method-result">string</span>
1786 <span class="method-name">
1787 javascript
1788 </span>
1789 ()
1790 </div>
1791
1792
1793
1794 </div>
1795 <a name="methodpre_confirm" id="pre_confirm"><!-- --></a>
1796 <div class="oddrow">
1797
1798 <div class="method-header">
1799 <span class="method-title">pre_confirm</span> (line <span class="line-number">277</span>)
1800 </div>
1801
1802 <!-- ========== Info from phpDoc block ========= -->
1803 <p class="short-description">This method allows this class to do any data munging prior to the form_confirm method being called @ render time.</p>
1804 <ul class="tags">
1805 <li><span class="field">return:</span> = success FALSE if u want to trigger an error</li>
1806 </ul>
1807
1808 <div class="method-signature">
1809 <span class="method-result">TRUE</span>
1810 <span class="method-name">
1811 pre_confirm
1812 </span>
1813 ()
1814 </div>
1815
1816
1817
1818 </div>
1819 <a name="methodset_action" id="set_action"><!-- --></a>
1820 <div class="evenrow">
1821
1822 <div class="method-header">
1823 <span class="method-title">set_action</span> (line <span class="line-number">675</span>)
1824 </div>
1825
1826 <!-- ========== Info from phpDoc block ========= -->
1827 <p class="short-description">Save the action for the form</p>
1828
1829 <div class="method-signature">
1830 <span class="method-result">void</span>
1831 <span class="method-name">
1832 set_action
1833 </span>
1834 (<span class="var-type">string</span>&nbsp;<span class="var-name">$action</span>)
1835 </div>
1836
1837 <ul class="parameters">
1838 <li>
1839 <span class="var-type">string</span>
1840 <span class="var-name">$action</span><span class="var-description">: - the action from the post.</span> </li>
1841 </ul>
1842
1843
1844 </div>
1845 <a name="methodset_action_message" id="set_action_message"><!-- --></a>
1846 <div class="oddrow">
1847
1848 <div class="method-header">
1849 <span class="method-title">set_action_message</span> (line <span class="line-number">822</span>)
1850 </div>
1851
1852 <!-- ========== Info from phpDoc block ========= -->
1853 <p class="short-description">This sets the action message.</p>
1854 <p class="description"><p>This is called from withint the form_action() method</p></p>
1855
1856 <div class="method-signature">
1857 <span class="method-result">void</span>
1858 <span class="method-name">
1859 set_action_message
1860 </span>
1861 (<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>)
1862 </div>
1863
1864 <ul class="parameters">
1865 <li>
1866 <span class="var-type">string</span>
1867 <span class="var-name">$message</span><span class="var-description">: - the action message</span> </li>
1868 </ul>
1869
1870
1871 </div>
1872 <a name="methodset_cancel_action" id="set_cancel_action"><!-- --></a>
1873 <div class="evenrow">
1874
1875 <div class="method-header">
1876 <span class="method-title">set_cancel_action</span> (line <span class="line-number">836</span>)
1877 </div>
1878
1879 <!-- ========== Info from phpDoc block ========= -->
1880 <p class="short-description">This method sets the javasript action</p>
1881 <p class="description"><p>to be taken when the cancel button is clicked. Calling this method w/ a non NULL value automatically enables the Cancel button.</p></p>
1882
1883 <div class="method-signature">
1884 <span class="method-result">void</span>
1885 <span class="method-name">
1886 set_cancel_action
1887 </span>
1888 (<span class="var-type">string</span>&nbsp;<span class="var-name">$action</span>)
1889 </div>
1890
1891 <ul class="parameters">
1892 <li>
1893 <span class="var-type">string</span>
1894 <span class="var-name">$action</span><span class="var-description">: - the javascript cancel action</span> </li>
1895 </ul>
1896
1897
1898 </div>
1899 <a name="methodset_confirm" id="set_confirm"><!-- --></a>
1900 <div class="oddrow">
1901
1902 <div class="method-header">
1903 <span class="method-title">set_confirm</span> (line <span class="line-number">788</span>)
1904 </div>
1905
1906 <!-- ========== Info from phpDoc block ========= -->
1907 <p class="short-description">This sets the $this-&gt;_has_confirmation</p>
1908 <p class="description"><p>flag. to let the object know it has a required confirmation page, which should get called after the validation is successfull, and before the action is handled on the back-end.</p></p>
1909
1910 <div class="method-signature">
1911 <span class="method-result">void</span>
1912 <span class="method-name">
1913 set_confirm
1914 </span>
1915 ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">TRUE</span>])
1916 </div>
1917
1918 <ul class="parameters">
1919 <li>
1920 <span class="var-type">boolean</span>
1921 <span class="var-name">$flag</span><span class="var-description">: - the flag value TRUE/FALSE</span> </li>
1922 </ul>
1923
1924
1925 </div>
1926 <a name="methodset_default_css" id="set_default_css"><!-- --></a>
1927 <div class="evenrow">
1928
1929 <div class="method-header">
1930 <span class="method-title">set_default_css</span> (line <span class="line-number">749</span>)
1931 </div>
1932
1933 <!-- ========== Info from phpDoc block ========= -->
1934 <p class="short-description">This function is used to set the</p>
1935 <p class="description"><p>default CSS class used on form field text when there is no error on that field</p></p>
1936
1937 <div class="method-signature">
1938 <span class="method-result">void</span>
1939 <span class="method-name">
1940 set_default_css
1941 </span>
1942 (<span class="var-type">string</span>&nbsp;<span class="var-name">$css</span>)
1943 </div>
1944
1945 <ul class="parameters">
1946 <li>
1947 <span class="var-type">string</span>
1948 <span class="var-name">$css</span><span class="var-description">: - the css class to use</span> </li>
1949 </ul>
1950
1951
1952 </div>
1953 <a name="methodset_element_value" id="set_element_value"><!-- --></a>
1954 <div class="oddrow">
1955
1956 <div class="method-header">
1957 <span class="method-title">set_element_value</span> (line <span class="line-number">573</span>)
1958 </div>
1959
1960 <!-- ========== Info from phpDoc block ========= -->
1961 <p class="short-description">This method is used to set the value for a non hidden element</p>
1962
1963 <div class="method-signature">
1964 <span class="method-result">void</span>
1965 <span class="method-name">
1966 set_element_value
1967 </span>
1968 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">value</span>&nbsp;<span class="var-name">$value</span>)
1969 </div>
1970
1971 <ul class="parameters">
1972 <li>
1973 <span class="var-type">string</span>
1974 <span class="var-name">$label</span><span class="var-description">: - the form label</span> </li>
1975 <li>
1976 <span class="var-type">value</span>
1977 <span class="var-name">$value</span><span class="var-description">: - the new value</span> </li>
1978 </ul>
1979
1980
1981 </div>
1982 <a name="methodset_error_css" id="set_error_css"><!-- --></a>
1983 <div class="evenrow">
1984
1985 <div class="method-header">
1986 <span class="method-title">set_error_css</span> (line <span class="line-number">773</span>)
1987 </div>
1988
1989 <!-- ========== Info from phpDoc block ========= -->
1990 <p class="short-description">This function is used to set the css class that is used on text when an error on that field is detected.</p>
1991
1992 <div class="method-signature">
1993 <span class="method-result">void</span>
1994 <span class="method-name">
1995 set_error_css
1996 </span>
1997 (<span class="var-type">string</span>&nbsp;<span class="var-name">$css</span>)
1998 </div>
1999
2000 <ul class="parameters">
2001 <li>
2002 <span class="var-type">string</span>
2003 <span class="var-name">$css</span><span class="var-description">: - the css class to use.</span> </li>
2004 </ul>
2005
2006
2007 </div>
2008 <a name="methodset_form_errors_title" id="set_form_errors_title"><!-- --></a>
2009 <div class="oddrow">
2010
2011 <div class="method-header">
2012 <span class="method-title">set_form_errors_title</span> (line <span class="line-number">734</span>)
2013 </div>
2014
2015 <!-- ========== Info from phpDoc block ========= -->
2016 <p class="short-description">This allows us to change the form errors table title</p>
2017
2018 <div class="method-signature">
2019 <span class="method-result">void</span>
2020 <span class="method-name">
2021 set_form_errors_title
2022 </span>
2023 (<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span>)
2024 </div>
2025
2026 <ul class="parameters">
2027 <li>
2028 <span class="var-type">string</span>
2029 <span class="var-name">$title</span><span class="var-description">: - the new title</span> </li>
2030 </ul>
2031
2032
2033 </div>
2034 <a name="methodset_form_errors_width" id="set_form_errors_width"><!-- --></a>
2035 <div class="evenrow">
2036
2037 <div class="method-header">
2038 <span class="method-title">set_form_errors_width</span> (line <span class="line-number">723</span>)
2039 </div>
2040
2041 <!-- ========== Info from phpDoc block ========= -->
2042 <p class="short-description">This method allows you to override the width of the form errors table.</p>
2043 <p class="description"><p>By default it uses the width of the form as its size.</p></p>
2044
2045 <div class="method-signature">
2046 <span class="method-result">void</span>
2047 <span class="method-name">
2048 set_form_errors_width
2049 </span>
2050 (<span class="var-type">string</span>&nbsp;<span class="var-name">$width</span>)
2051 </div>
2052
2053 <ul class="parameters">
2054 <li>
2055 <span class="var-type">string</span>
2056 <span class="var-name">$width</span><span class="var-description">: - the width</span> </li>
2057 </ul>
2058
2059
2060 </div>
2061 <a name="methodset_form_name" id="set_form_name"><!-- --></a>
2062 <div class="oddrow">
2063
2064 <div class="method-header">
2065 <span class="method-title">set_form_name</span> (line <span class="line-number">665</span>)
2066 </div>
2067
2068 <!-- ========== Info from phpDoc block ========= -->
2069 <p class="short-description">**************************</p>
2070
2071 <div class="method-signature">
2072 <span class="method-result">void</span>
2073 <span class="method-name">
2074 set_form_name
2075 </span>
2076 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$name</span>)
2077 </div>
2078
2079
2080
2081 </div>
2082 <a name="methodset_form_tabindex" id="set_form_tabindex"><!-- --></a>
2083 <div class="evenrow">
2084
2085 <div class="method-header">
2086 <span class="method-title">set_form_tabindex</span> (line <span class="line-number">623</span>)
2087 </div>
2088
2089 <!-- ========== Info from phpDoc block ========= -->
2090 <p class="short-description">This method is a helper method to set the FormElement's tabindex.</p>
2091
2092 <div class="method-signature">
2093 <span class="method-result">none</span>
2094 <span class="method-name">
2095 set_form_tabindex
2096 </span>
2097 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$index</span>)
2098 </div>
2099
2100 <ul class="parameters">
2101 <li>
2102 <span class="var-type">string</span>
2103 <span class="var-name">$label</span><span class="var-description">: - the form label</span> </li>
2104 <li>
2105 <span class="var-type">int</span>
2106 <span class="var-name">$index</span><span class="var-description">: - the FormElement's tabindex</span> </li>
2107 </ul>
2108
2109
2110 </div>
2111 <a name="methodset_form_width" id="set_form_width"><!-- --></a>
2112 <div class="oddrow">
2113
2114 <div class="method-header">
2115 <span class="method-title">set_form_width</span> (line <span class="line-number">694</span>)
2116 </div>
2117
2118 <!-- ========== Info from phpDoc block ========= -->
2119 <p class="short-description">this method sets the form name</p>
2120
2121 <div class="method-signature">
2122 <span class="method-result">void</span>
2123 <span class="method-name">
2124 set_form_width
2125 </span>
2126 (<span class="var-type">string</span>&nbsp;<span class="var-name">$width</span>)
2127 </div>
2128
2129 <ul class="parameters">
2130 <li>
2131 <span class="var-type">string</span>
2132 <span class="var-name">$width</span><span class="var-description">: - the form name</span> </li>
2133 </ul>
2134
2135
2136 </div>
2137 <a name="methodset_hidden_element_value" id="set_hidden_element_value"><!-- --></a>
2138 <div class="evenrow">
2139
2140 <div class="method-header">
2141 <span class="method-title">set_hidden_element_value</span> (line <span class="line-number">598</span>)
2142 </div>
2143
2144 <!-- ========== Info from phpDoc block ========= -->
2145 <p class="short-description">This method is used to set the value for a hidden element</p>
2146
2147 <div class="method-signature">
2148 <span class="method-result">void</span>
2149 <span class="method-name">
2150 set_hidden_element_value
2151 </span>
2152 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">value</span>&nbsp;<span class="var-name">$value</span>)
2153 </div>
2154
2155 <ul class="parameters">
2156 <li>
2157 <span class="var-type">string</span>
2158 <span class="var-name">$label</span><span class="var-description">: - the form label</span> </li>
2159 <li>
2160 <span class="var-type">value</span>
2161 <span class="var-name">$value</span><span class="var-description">: - the new value</span> </li>
2162 </ul>
2163
2164
2165 </div>
2166 <a name="methodset_required_marker" id="set_required_marker"><!-- --></a>
2167 <div class="oddrow">
2168
2169 <div class="method-header">
2170 <span class="method-title">set_required_marker</span> (line <span class="line-number">994</span>)
2171 </div>
2172
2173 <!-- ========== Info from phpDoc block ========= -->
2174 <p class="short-description">This function is used to set the required field marker</p>
2175
2176 <div class="method-signature">
2177 <span class="method-result">void</span>
2178 <span class="method-name">
2179 set_required_marker
2180 </span>
2181 (<span class="var-type">string</span>&nbsp;<span class="var-name">$marker</span>)
2182 </div>
2183
2184 <ul class="parameters">
2185 <li>
2186 <span class="var-type">string</span>
2187 <span class="var-name">$marker</span><span class="var-description">: - the marker</span> </li>
2188 </ul>
2189
2190
2191 </div>
2192 <a name="methodset_required_text" id="set_required_text"><!-- --></a>
2193 <div class="evenrow">
2194
2195 <div class="method-header">
2196 <span class="method-title">set_required_text</span> (line <span class="line-number">1003</span>)
2197 </div>
2198
2199 <!-- ========== Info from phpDoc block ========= -->
2200 <p class="short-description">This sets the required text</p>
2201
2202 <div class="method-signature">
2203 <span class="method-result">void</span>
2204 <span class="method-name">
2205 set_required_text
2206 </span>
2207 (<span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>)
2208 </div>
2209
2210 <ul class="parameters">
2211 <li>
2212 <span class="var-type">string</span>
2213 <span class="var-name">$text</span> </li>
2214 </ul>
2215
2216
2217 </div>
2218 <a name="methodset_stripslashes" id="set_stripslashes"><!-- --></a>
2219 <div class="oddrow">
2220
2221 <div class="method-header">
2222 <span class="method-title">set_stripslashes</span> (line <span class="line-number">811</span>)
2223 </div>
2224
2225 <!-- ========== Info from phpDoc block ========= -->
2226 <p class="short-description">This sets the stripslashes flag for this object.</p>
2227
2228 <div class="method-signature">
2229 <span class="method-result">void</span>
2230 <span class="method-name">
2231 set_stripslashes
2232 </span>
2233 ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">TRUE</span>])
2234 </div>
2235
2236 <ul class="parameters">
2237 <li>
2238 <span class="var-type">boolean</span>
2239 <span class="var-name">$flag</span> </li>
2240 </ul>
2241
2242
2243 </div>
2244 <a name="method_pre_confirm" id="_pre_confirm"><!-- --></a>
2245 <div class="evenrow">
2246
2247 <div class="method-header">
2248 <span class="method-title">_pre_confirm</span> (line <span class="line-number">292</span>)
2249 </div>
2250
2251 <!-- ========== Info from phpDoc block ========= -->
2252 <p class="short-description">This is a 'hidden' version of pre_confirm to allow calling the form elements pre_confirm methods. This is needed for forms that have a confirmation requirement and has file inputs.</p>
2253 <p class="description"><p>If the file input FormElement doesn't save off the uploaded file, then the confirmation page will not get the file. apache may nuke the temp file in /tmp.</p></p>
2254
2255 <div class="method-signature">
2256 <span class="method-result">void</span>
2257 <span class="method-name">
2258 _pre_confirm
2259 </span>
2260 ()
2261 </div>
2262
2263
2264
2265 </div>
2266 <a name="method_test_element" id="_test_element"><!-- --></a>
2267 <div class="oddrow">
2268
2269 <div class="method-header">
2270 <span class="method-title">_test_element</span> (line <span class="line-number">1018</span>)
2271 </div>
2272
2273 <!-- ========== Info from phpDoc block ========= -->
2274 <p class="short-description">This method tests to see if we have an element named $label, so we can operate on it.</p>
2275
2276 <div class="method-signature">
2277 <span class="method-result">void</span>
2278 <span class="method-name">
2279 _test_element
2280 </span>
2281 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$method</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$hidden</span> = <span class="var-default">FALSE</span>])
2282 </div>
2283
2284 <ul class="parameters">
2285 <li>
2286 <span class="var-type">string</span>
2287 <span class="var-name">$label</span><span class="var-description">: - the element's label</span> </li>
2288 <li>
2289 <span class="var-type">string</span>
2290 <span class="var-name">$method</span><span class="var-description">: - the name of the method that called us</span> </li>
2291 <li>
2292 <span class="var-type">boolean</span>
2293 <span class="var-name">$hidden</span><span class="var-description">: - test a hidden element?</span> </li>
2294 </ul>
2295
2296
2297 </div>
2298
2299 </div>
2300 </div>
2301
2302
2303 <p class="notes" id="credit">
2304 Documentation generated on Thu, 1 Apr 2004 09:38:49 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a>
2305 </p>
2306 </div></body>
2307 </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed