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

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

Parent Directory Parent Directory | Revision Log Revision Log

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