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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.2 - (hide annotations)
Sat Sep 20 00:37:09 2003 UTC (20 years, 11 months ago) by jonen
Branch: MAIN
Changes since 1.1: +1739 -1268 lines
File MIME type: text/html
+ updated whole phphtmllib to v2.3.0

1 jonen 1.2 <?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 FormElement</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 FormElement</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 is the base FormElement object. It can be single form field such as a text input field, or a complex object.</p>
27     <p class="description"><p>Usefull Functions</p><p>get_value() - This gets the current 'value' of the FormElement. NOTE: This can be a 'complex' FormElement in which it may return an array of values.</p><p>set_value() - Set the current value for this FormElement.</p><p>get_label() - returns the label for this FormElement.</p></p>
28     <p class="notes">
29     Located in <a class="field" href="_form_FormElement_inc.html">Program_Root/form/FormElement.inc</a> (line <span class="field">39</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/FormProcessing/FEHidden.html">FEHidden</a></td>
56     <td>
57     This is the Hidden FormElement which builds a input field of type=&quot;hidden&quot;. It has no validation method.
58     </td>
59     </tr>
60     <tr>
61     <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEError.html">FEError</a></td>
62     <td>
63     This is a way of providing an Error to the FormProcessor.
64     </td>
65     </tr>
66     <tr>
67     <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEText.html">FEText</a></td>
68     <td>
69     This is the Text FormElement which builds a text input field. It has no validation method.
70     </td>
71     </tr>
72     <tr>
73     <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></td>
74     <td>
75     This is the Box FormElement which builds a DIV with a width and a height. It is a base class for more complicated FormElements.
76     </td>
77     </tr>
78     <tr>
79     <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FECheckBox.html">FECheckBox</a></td>
80     <td>
81     This is the CheckBox FormElement which builds a input field of type=&quot;checkbox&quot;. It has no validation method.
82     </td>
83     </tr>
84     <tr>
85     <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FERadioGroup.html">FERadioGroup</a></td>
86     <td>
87     This is the Radio Button Group FormElement which builds a List of Radio buttons that can be used in any style of layout.
88     </td>
89     </tr>
90     </table>
91     </div>
92     </div>
93    
94     <a name="sec-var-summary"></a>
95     <div class="info-box">
96     <div class="info-box-title">Variable Summary</span></div>
97     <div class="nav-bar">
98     <a href="#sec-description">Description</a> |
99     <a href="#sec-descendents">Descendents</a> |
100     <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
101     |
102     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
103    
104     </div>
105     <div class="info-box-body">
106     <div class="var-summary">
107     <div class="var-title">
108     <span class="var-type">mixed</span>
109     <a href="#$_attributes" title="details" class="var-name">$_attributes</a>
110     </div>
111     <div class="var-title">
112     <span class="var-type">mixed</span>
113     <a href="#$_element_name" title="details" class="var-name">$_element_name</a>
114     </div>
115     <div class="var-title">
116     <span class="var-type">mixed</span>
117     <a href="#$_errors" title="details" class="var-name">$_errors</a>
118     </div>
119     <div class="var-title">
120     <span class="var-type">mixed</span>
121     <a href="#$_error_message" title="details" class="var-name">$_error_message</a>
122     </div>
123     <div class="var-title">
124     <span class="var-type">mixed</span>
125     <a href="#$_form_name" title="details" class="var-name">$_form_name</a>
126     </div>
127     <div class="var-title">
128     <span class="var-type">mixed</span>
129     <a href="#$_has_error" title="details" class="var-name">$_has_error</a>
130     </div>
131     <div class="var-title">
132     <span class="var-type">mixed</span>
133     <a href="#$_is_disabled" title="details" class="var-name">$_is_disabled</a>
134     </div>
135     <div class="var-title">
136     <span class="var-type">mixed</span>
137     <a href="#$_is_required" title="details" class="var-name">$_is_required</a>
138     </div>
139     <div class="var-title">
140     <span class="var-type">mixed</span>
141     <a href="#$_label_text" title="details" class="var-name">$_label_text</a>
142     </div>
143     <div class="var-title">
144     <span class="var-type">mixed</span>
145     <a href="#$_stripslashes" title="details" class="var-name">$_stripslashes</a>
146     </div>
147     <div class="var-title">
148     <span class="var-type">mixed</span>
149     <a href="#$_style_attributes" title="details" class="var-name">$_style_attributes</a>
150     </div>
151     <div class="var-title">
152     <span class="var-type">mixed</span>
153     <a href="#$_value" title="details" class="var-name">$_value</a>
154     </div>
155     </div>
156     </div>
157     </div>
158    
159     <a name="sec-method-summary"></a>
160     <div class="info-box">
161     <div class="info-box-title">Method Summary</span></div>
162     <div class="nav-bar">
163     <a href="#sec-description">Description</a> |
164     <a href="#sec-descendents">Descendents</a> |
165     <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
166    
167     |
168     <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
169     </div>
170     <div class="info-box-body">
171     <div class="method-summary">
172    
173     <div class="method-definition">
174     <span class="method-result">void</span>
175     <a href="#FormElement" title="details" class="method-name">FormElement</a>
176     (<span class="var-type">label</span>&nbsp;<span class="var-name">$label</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$required</span> = <span class="var-default">TRUE</span>])
177     </div>
178    
179     <div class="method-definition">
180     <span class="method-result">void</span>
181     <a href="#create_element_name" title="details" class="method-name">create_element_name</a>
182     ()
183     </div>
184    
185     <div class="method-definition">
186     <span class="method-result">mixed</span>
187     <a href="#get_attribute" title="details" class="method-name">get_attribute</a>
188     (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
189     </div>
190    
191     <div class="method-definition">
192     <span class="method-result">object</span>
193     <a href="#get_element" title="details" class="method-name">get_element</a>
194     ()
195     </div>
196    
197     <div class="method-definition">
198     <span class="method-result">string</span>
199     <a href="#get_element_name" title="details" class="method-name">get_element_name</a>
200     ()
201     </div>
202    
203     <div class="method-definition">
204     <span class="method-result">void</span>
205     <a href="#get_errors" title="details" class="method-name">get_errors</a>
206     (<span class="var-type">array</span>&nbsp;<span class="var-name">0</span>)
207     </div>
208    
209     <div class="method-definition">
210     <span class="method-result">mesage</span>
211     <a href="#get_error_message" title="details" class="method-name">get_error_message</a>
212     ()
213     </div>
214    
215     <div class="method-definition">
216     <span class="method-result">mixed</span>
217     <a href="#get_init_value" title="details" class="method-name">get_init_value</a>
218     ()
219     </div>
220    
221     <div class="method-definition">
222     <span class="method-result"><a href="../../phpHtmlLib/SPANtag.html">object SPANtag</a></span>
223     <a href="#get_label" title="details" class="method-name">get_label</a>
224     ()
225     </div>
226    
227     <div class="method-definition">
228     <span class="method-result">string</span>
229     <a href="#get_label_text" title="details" class="method-name">get_label_text</a>
230     ()
231     </div>
232    
233     <div class="method-definition">
234     <span class="method-result">string</span>
235     <a href="#get_required_symbol" title="details" class="method-name">get_required_symbol</a>
236     ()
237     </div>
238    
239     <div class="method-definition">
240     <span class="method-result">mixed</span>
241     <a href="#get_value" title="details" class="method-name">get_value</a>
242     ()
243     </div>
244    
245     <div class="method-definition">
246     <span class="method-result">string</span>
247     <a href="#get_value_text" title="details" class="method-name">get_value_text</a>
248     (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
249     </div>
250    
251     <div class="method-definition">
252     <span class="method-result">bool</span>
253     <a href="#has_error" title="details" class="method-name">has_error</a>
254     ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$label</span> = <span class="var-default">NULL</span>])
255     </div>
256    
257     <div class="method-definition">
258     <span class="method-result">bool</span>
259     <a href="#is_disabled" title="details" class="method-name">is_disabled</a>
260     ()
261     </div>
262    
263     <div class="method-definition">
264     <span class="method-result">bool</span>
265     <a href="#is_required" title="details" class="method-name">is_required</a>
266     ()
267     </div>
268    
269     <div class="method-definition">
270     <span class="method-result">string</span>
271     <a href="#javascript" title="details" class="method-name">javascript</a>
272     ()
273     </div>
274    
275     <div class="method-definition">
276     <span class="method-result">string</span>
277     <a href="#onBlur" title="details" class="method-name">onBlur</a>
278     ()
279     </div>
280    
281     <div class="method-definition">
282     <span class="method-result">string</span>
283     <a href="#onChange" title="details" class="method-name">onChange</a>
284     ()
285     </div>
286    
287     <div class="method-definition">
288     <span class="method-result">string</span>
289     <a href="#onClick" title="details" class="method-name">onClick</a>
290     ()
291     </div>
292    
293     <div class="method-definition">
294     <span class="method-result">string</span>
295     <a href="#onFocus" title="details" class="method-name">onFocus</a>
296     ()
297     </div>
298    
299     <div class="method-definition">
300     <span class="method-result">string</span>
301     <a href="#onSubmit" title="details" class="method-name">onSubmit</a>
302     ()
303     </div>
304    
305     <div class="method-definition">
306     <span class="method-result">void</span>
307     <a href="#set_attribute" title="details" class="method-name">set_attribute</a>
308     (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">NULL</span>])
309     </div>
310    
311     <div class="method-definition">
312     <span class="method-result">void</span>
313     <a href="#set_disabled" title="details" class="method-name">set_disabled</a>
314     (<span class="var-type">bool</span>&nbsp;<span class="var-name">$flag</span>)
315     </div>
316    
317     <div class="method-definition">
318     <span class="method-result">void</span>
319     <a href="#set_error_message" title="details" class="method-name">set_error_message</a>
320     (<span class="var-type">mesage</span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type">label</span>&nbsp;<span class="var-name">$label</span> = <span class="var-default">NULL</span>])
321     </div>
322    
323     <div class="method-definition">
324     <span class="method-result">void</span>
325     <a href="#set_form_name" title="details" class="method-name">set_form_name</a>
326     (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
327     </div>
328    
329     <div class="method-definition">
330     <span class="method-result">void</span>
331     <a href="#set_label_text" title="details" class="method-name">set_label_text</a>
332     (<span class="var-type">label</span>&nbsp;<span class="var-name">$label</span>)
333     </div>
334    
335     <div class="method-definition">
336     <span class="method-result">void</span>
337     <a href="#set_required" title="details" class="method-name">set_required</a>
338     (<span class="var-type">bool</span>&nbsp;<span class="var-name">$required</span>)
339     </div>
340    
341     <div class="method-definition">
342     <span class="method-result">void</span>
343     <a href="#set_stripslashes" title="details" class="method-name">set_stripslashes</a>
344     ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">TRUE</span>])
345     </div>
346    
347     <div class="method-definition">
348     <span class="method-result">void</span>
349     <a href="#set_style_attribute" title="details" class="method-name">set_style_attribute</a>
350     (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
351     </div>
352    
353     <div class="method-definition">
354     <span class="method-result">void</span>
355     <a href="#set_title" title="details" class="method-name">set_title</a>
356     (<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span>)
357     </div>
358    
359     <div class="method-definition">
360     <span class="method-result">void</span>
361     <a href="#set_value" title="details" class="method-name">set_value</a>
362     (<span class="var-type">value</span>&nbsp;<span class="var-name">$value</span>)
363     </div>
364    
365     <div class="method-definition">
366     <span class="method-result">void</span>
367     <a href="#validate" title="details" class="method-name">validate</a>
368     (<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>&nbsp;<span class="var-name">&$_FormValidation</span>)
369     </div>
370    
371     <div class="method-definition">
372     <span class="method-result">array</span>
373     <a href="#_build_element_attributes" title="details" class="method-name">_build_element_attributes</a>
374     ()
375     </div>
376    
377     <div class="method-definition">
378     <span class="method-result">array</span>
379     <a href="#_build_javascript" title="details" class="method-name">_build_javascript</a>
380     ()
381     </div>
382    
383     <div class="method-definition">
384     <span class="method-result">void</span>
385     <a href="#_do_validation" title="details" class="method-name">_do_validation</a>
386     (<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>&nbsp;<span class="var-name">&$_FormValidation</span>)
387     </div>
388     </div>
389     </div>
390     </div>
391    
392     <a name="sec-vars"></a>
393     <div class="info-box">
394     <div class="info-box-title">Variables</div>
395     <div class="nav-bar">
396     <a href="#sec-description">Description</a> |
397     <a href="#sec-descendents">Descendents</a> |
398     <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
399    
400    
401     |
402     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
403    
404     </div>
405     <div class="info-box-body">
406     <a name="var$_attributes" id="$_attributes"><!-- --></A>
407     <div class="evenrow">
408    
409     <div class="var-header">
410     <span class="var-title">
411     <span class="var-type">mixed</span>
412     <span class="var-name">$_attributes</span>
413     (line <span class="line-number">92</span>)
414     </span>
415     </div>
416    
417     <!-- ========== Info from phpDoc block ========= -->
418     <p class="short-description">Holds additional attributes for</p>
419     <p class="description"><p>the elements html tag</p></p>
420    
421    
422    
423    
424    
425     </div>
426     <a name="var$_element_name" id="$_element_name"><!-- --></A>
427     <div class="oddrow">
428    
429     <div class="var-header">
430     <span class="var-title">
431     <span class="var-type">mixed</span>
432     <span class="var-name">$_element_name</span>
433     = <span class="var-default"> NULL</span> (line <span class="line-number">85</span>)
434     </span>
435     </div>
436    
437     <!-- ========== Info from phpDoc block ========= -->
438     <p class="short-description">Holds the name of the element</p>
439     <p class="description"><p>as it appears in the form html tag</p></p>
440    
441    
442    
443    
444    
445     </div>
446     <a name="var$_errors" id="$_errors"><!-- --></A>
447     <div class="evenrow">
448    
449     <div class="var-header">
450     <span class="var-title">
451     <span class="var-type">mixed</span>
452     <span class="var-name">$_errors</span>
453     = <span class="var-default">array()</span> (line <span class="line-number">64</span>)
454     </span>
455     </div>
456    
457     <!-- ========== Info from phpDoc block ========= -->
458     <p class="short-description">holds the array of errors for this element.</p>
459    
460    
461    
462    
463    
464     </div>
465     <a name="var$_error_message" id="$_error_message"><!-- --></A>
466     <div class="oddrow">
467    
468     <div class="var-header">
469     <span class="var-title">
470     <span class="var-type">mixed</span>
471     <span class="var-name">$_error_message</span>
472     = <span class="var-default"> NULL</span> (line <span class="line-number">71</span>)
473     </span>
474     </div>
475    
476     <!-- ========== Info from phpDoc block ========= -->
477     <p class="short-description">Holds the error message text</p>
478     <p class="description"><p>for validation errors, if any</p></p>
479    
480    
481    
482    
483    
484     </div>
485     <a name="var$_form_name" id="$_form_name"><!-- --></A>
486     <div class="evenrow">
487    
488     <div class="var-header">
489     <span class="var-title">
490     <span class="var-type">mixed</span>
491     <span class="var-name">$_form_name</span>
492     (line <span class="line-number">118</span>)
493     </span>
494     </div>
495    
496     <!-- ========== Info from phpDoc block ========= -->
497     <p class="short-description">This holds the name of the form</p>
498     <p class="description"><p>for js that needs it</p></p>
499    
500    
501    
502    
503    
504     </div>
505     <a name="var$_has_error" id="$_has_error"><!-- --></A>
506     <div class="oddrow">
507    
508     <div class="var-header">
509     <span class="var-title">
510     <span class="var-type">mixed</span>
511     <span class="var-name">$_has_error</span>
512     = <span class="var-default"> FALSE</span> (line <span class="line-number">78</span>)
513     </span>
514     </div>
515    
516     <!-- ========== Info from phpDoc block ========= -->
517     <p class="short-description">Holds the state of the last validation</p>
518     <p class="description"><p>Sets to true in case of a validation error</p></p>
519    
520    
521    
522    
523    
524     </div>
525     <a name="var$_is_disabled" id="$_is_disabled"><!-- --></A>
526     <div class="evenrow">
527    
528     <div class="var-header">
529     <span class="var-title">
530     <span class="var-type">mixed</span>
531     <span class="var-name">$_is_disabled</span>
532     = <span class="var-default"> FALSE</span> (line <span class="line-number">105</span>)
533     </span>
534     </div>
535    
536     <!-- ========== Info from phpDoc block ========= -->
537     <p class="short-description">Indicates a disabled element</p>
538    
539    
540    
541    
542    
543     </div>
544     <a name="var$_is_required" id="$_is_required"><!-- --></A>
545     <div class="oddrow">
546    
547     <div class="var-header">
548     <span class="var-title">
549     <span class="var-type">mixed</span>
550     <span class="var-name">$_is_required</span>
551     = <span class="var-default"> TRUE</span> (line <span class="line-number">58</span>)
552     </span>
553     </div>
554    
555     <!-- ========== Info from phpDoc block ========= -->
556     <p class="short-description">Indicates whether this elements</p>
557     <p class="description"><p>final value is required and cannot be empty</p></p>
558    
559    
560    
561    
562    
563     </div>
564     <a name="var$_label_text" id="$_label_text"><!-- --></A>
565     <div class="evenrow">
566    
567     <div class="var-header">
568     <span class="var-title">
569     <span class="var-type">mixed</span>
570     <span class="var-name">$_label_text</span>
571     = <span class="var-default"> NULL</span> (line <span class="line-number">45</span>)
572     </span>
573     </div>
574    
575     <!-- ========== Info from phpDoc block ========= -->
576     <p class="short-description">Holds the elements label text</p>
577    
578    
579    
580    
581    
582     </div>
583     <a name="var$_stripslashes" id="$_stripslashes"><!-- --></A>
584     <div class="oddrow">
585    
586     <div class="var-header">
587     <span class="var-title">
588     <span class="var-type">mixed</span>
589     <span class="var-name">$_stripslashes</span>
590     = <span class="var-default"> FALSE</span> (line <span class="line-number">111</span>)
591     </span>
592     </div>
593    
594     <!-- ========== Info from phpDoc block ========= -->
595     <p class="short-description">automatically strip slashes from</p>
596     <p class="description"><p>form values?</p></p>
597    
598    
599    
600    
601    
602     </div>
603     <a name="var$_style_attributes" id="$_style_attributes"><!-- --></A>
604     <div class="evenrow">
605    
606     <div class="var-header">
607     <span class="var-title">
608     <span class="var-type">mixed</span>
609     <span class="var-name">$_style_attributes</span>
610     (line <span class="line-number">99</span>)
611     </span>
612     </div>
613    
614     <!-- ========== Info from phpDoc block ========= -->
615     <p class="short-description">Holds additional style attributes for</p>
616     <p class="description"><p>the elements html tag</p></p>
617    
618    
619    
620    
621    
622     </div>
623     <a name="var$_value" id="$_value"><!-- --></A>
624     <div class="oddrow">
625    
626     <div class="var-header">
627     <span class="var-title">
628     <span class="var-type">mixed</span>
629     <span class="var-name">$_value</span>
630     = <span class="var-default"> NULL</span> (line <span class="line-number">51</span>)
631     </span>
632     </div>
633 jonen 1.1
634 jonen 1.2 <!-- ========== Info from phpDoc block ========= -->
635     <p class="short-description">Holds the elements initial value</p>
636    
637    
638    
639    
640 jonen 1.1
641 jonen 1.2 </div>
642    
643     </div>
644     </div>
645    
646     <a name="sec-methods"></a>
647     <div class="info-box">
648     <div class="info-box-title">Methods</div>
649     <div class="nav-bar">
650     <a href="#sec-description">Description</a> |
651     <a href="#sec-descendents">Descendents</a> |
652     <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
653     <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
654    
655     </div>
656     <div class="info-box-body">
657     <A NAME='method_detail'></A>
658     <a name="methodFormElement" id="FormElement"><!-- --></a>
659     <div class="evenrow">
660    
661     <div class="method-header">
662     <span class="method-title">Constructor FormElement</span> (line <span class="line-number">127</span>)
663     </div>
664    
665     <!-- ========== Info from phpDoc block ========= -->
666     <p class="short-description">The constructor</p>
667    
668     <div class="method-signature">
669     <span class="method-result">void</span>
670     <span class="method-name">
671     FormElement
672     </span>
673     (<span class="var-type">label</span>&nbsp;<span class="var-name">$label</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$required</span> = <span class="var-default">TRUE</span>])
674     </div>
675    
676     <ul class="parameters">
677     <li>
678     <span class="var-type">label</span>
679     <span class="var-name">$label</span><span class="var-description">: <p>string - text label for the element</p></span> </li>
680     <li>
681     <span class="var-type">bool</span>
682     <span class="var-name">$required</span><span class="var-description">: <p>required - is this a required element</p></span> </li>
683     </ul>
684    
685    
686     </div>
687     <a name="methodcreate_element_name" id="create_element_name"><!-- --></a>
688     <div class="oddrow">
689    
690     <div class="method-header">
691     <span class="method-title">create_element_name</span> (line <span class="line-number">401</span>)
692     </div>
693    
694     <!-- ========== Info from phpDoc block ========= -->
695     <p class="short-description">This function creates element name</p>
696     <p class="description"><p>used in the form based on the text label or any other parameters</p></p>
697    
698     <div class="method-signature">
699     <span class="method-result">void</span>
700     <span class="method-name">
701     create_element_name
702     </span>
703     ()
704     </div>
705    
706    
707    
708     <hr class="separator" />
709     <div class="notes">Redefined in descendants as:</div>
710     <ul class="redefinitions">
711     <li>
712     <a href="../../phpHtmlLib/FormProcessing/FEMultiListBox.html#methodcreate_element_name">FEMultiListBox::create_element_name()</a>
713     : This function creates element name used in the form based on the text label or any other parameters
714     </li>
715     </ul>
716     </div>
717     <a name="methodget_attribute" id="get_attribute"><!-- --></a>
718     <div class="evenrow">
719    
720     <div class="method-header">
721     <span class="method-title">get_attribute</span> (line <span class="line-number">301</span>)
722     </div>
723    
724     <!-- ========== Info from phpDoc block ========= -->
725     <p class="short-description">return a single attribute</p>
726     <ul class="tags">
727     <li><span class="field">return:</span> <p>the value</p></li>
728     </ul>
729    
730     <div class="method-signature">
731     <span class="method-result">mixed</span>
732     <span class="method-name">
733     get_attribute
734     </span>
735     (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
736     </div>
737    
738     <ul class="parameters">
739     <li>
740     <span class="var-type">string</span>
741     <span class="var-name">$name</span><span class="var-description">: <p>attribute name</p></span> </li>
742     </ul>
743    
744    
745     </div>
746     <a name="methodget_element" id="get_element"><!-- --></a>
747     <div class="oddrow">
748    
749     <div class="method-header">
750     <span class="method-title">get_element</span> (line <span class="line-number">656</span>)
751     </div>
752    
753     <!-- ========== Info from phpDoc block ========= -->
754     <p class="short-description">This function builds and returns the form element object</p>
755    
756     <div class="method-signature">
757     <span class="method-result">object</span>
758     <span class="method-name">
759     get_element
760     </span>
761     ()
762     </div>
763    
764    
765    
766     <hr class="separator" />
767     <div class="notes">Redefined in descendants as:</div>
768     <ul class="redefinitions">
769     <li>
770     <a href="../../phpHtmlLib/FormProcessing/FEHidden.html#methodget_element">FEHidden::get_element()</a>
771     </li>
772     <li>
773     <a href="../../phpHtmlLib/FormProcessing/FEText.html#methodget_element">FEText::get_element()</a>
774     : This function builds and returns the form element object
775     </li>
776     <li>
777     <a href="../../phpHtmlLib/FormProcessing/FEFile.html#methodget_element">FEFile::get_element()</a>
778     : This function builds and returns the form element object
779     </li>
780     <li>
781     <a href="../../phpHtmlLib/FormProcessing/FEHostNameWithPort.html#methodget_element">FEHostNameWithPort::get_element()</a>
782     : This function builds and returns the form element object
783     </li>
784     <li>
785     <a href="../../phpHtmlLib/FormProcessing/FEPassword.html#methodget_element">FEPassword::get_element()</a>
786     : This function builds and returns the form element object
787     </li>
788     <li>
789     <a href="../../phpHtmlLib/FormProcessing/FETextArea.html#methodget_element">FETextArea::get_element()</a>
790     : This function builds and returns the form element object
791     </li>
792     <li>
793     <a href="../../phpHtmlLib/FormProcessing/FEListBox.html#methodget_element">FEListBox::get_element()</a>
794     : This function builds and returns the form element object
795     </li>
796     <li>
797     <a href="../../phpHtmlLib/FormProcessing/FEMultiListBox.html#methodget_element">FEMultiListBox::get_element()</a>
798     : This function builds and returns the form element object
799     </li>
800     <li>
801     <a href="../../phpHtmlLib/FormProcessing/FECheckBoxList.html#methodget_element">FECheckBoxList::get_element()</a>
802     : This function builds and returns the form element object
803     </li>
804     <li>
805     <a href="../../phpHtmlLib/FormProcessing/FEButton.html#methodget_element">FEButton::get_element()</a>
806     : This function builds and returns the form element object
807     </li>
808     <li>
809     <a href="../../phpHtmlLib/FormProcessing/FESubmitButton.html#methodget_element">FESubmitButton::get_element()</a>
810     : This function builds and returns the form element object
811     </li>
812     <li>
813     <a href="../../phpHtmlLib/FormProcessing/FECheckBox.html#methodget_element">FECheckBox::get_element()</a>
814     : This function builds and returns the form element object
815     </li>
816     <li>
817     <a href="../../phpHtmlLib/FormProcessing/FERadioGroup.html#methodget_element">FERadioGroup::get_element()</a>
818     : This function builds and returns the form element object
819     </li>
820     </ul>
821     </div>
822     <a name="methodget_element_name" id="get_element_name"><!-- --></a>
823     <div class="evenrow">
824    
825     <div class="method-header">
826     <span class="method-title">get_element_name</span> (line <span class="line-number">420</span>)
827     </div>
828    
829     <!-- ========== Info from phpDoc block ========= -->
830     <p class="short-description">Returns the element name to be used in the form</p>
831     <ul class="tags">
832     <li><span class="field">return:</span> <p>form element name</p></li>
833     </ul>
834    
835     <div class="method-signature">
836     <span class="method-result">string</span>
837     <span class="method-name">
838     get_element_name
839     </span>
840     ()
841     </div>
842    
843    
844    
845 jonen 1.1 </div>
846 jonen 1.2 <a name="methodget_errors" id="get_errors"><!-- --></a>
847     <div class="oddrow">
848    
849     <div class="method-header">
850     <span class="method-title">get_errors</span> (line <span class="line-number">353</span>)
851     </div>
852    
853     <!-- ========== Info from phpDoc block ========= -->
854     <p class="short-description">This returns the array of errors for this element</p>
855    
856     <div class="method-signature">
857     <span class="method-result">void</span>
858     <span class="method-name">
859     get_errors
860     </span>
861     (<span class="var-type">array</span>&nbsp;<span class="var-name">0</span>)
862     </div>
863    
864     <ul class="parameters">
865     <li>
866     <span class="var-type">array</span>
867     <span class="var-name">0</span><span class="var-description">: <p>of errors</p></span> </li>
868     </ul>
869    
870    
871     </div>
872     <a name="methodget_error_message" id="get_error_message"><!-- --></a>
873     <div class="evenrow">
874    
875     <div class="method-header">
876     <span class="method-title">get_error_message</span> (line <span class="line-number">364</span>)
877     </div>
878    
879     <!-- ========== Info from phpDoc block ========= -->
880     <p class="short-description">Returns the current error message if any</p>
881     <ul class="tags">
882     <li><span class="field">return:</span> <p>text - error message</p></li>
883     </ul>
884    
885     <div class="method-signature">
886     <span class="method-result">mesage</span>
887     <span class="method-name">
888     get_error_message
889     </span>
890     ()
891     </div>
892    
893    
894    
895     </div>
896     <a name="methodget_init_value" id="get_init_value"><!-- --></a>
897     <div class="oddrow">
898    
899     <div class="method-header">
900     <span class="method-title">get_init_value</span> (line <span class="line-number">240</span>)
901     </div>
902    
903     <!-- ========== Info from phpDoc block ========= -->
904     <p class="short-description">This returns the initial value of the element</p>
905    
906     <div class="method-signature">
907     <span class="method-result">mixed</span>
908     <span class="method-name">
909     get_init_value
910     </span>
911     ()
912     </div>
913    
914    
915    
916     </div>
917     <a name="methodget_label" id="get_label"><!-- --></a>
918     <div class="evenrow">
919    
920     <div class="method-header">
921     <span class="method-title">get_label</span> (line <span class="line-number">634</span>)
922     </div>
923    
924     <!-- ========== Info from phpDoc block ========= -->
925     <p class="short-description">This function builds and returns a label object based on the label text and error conditions</p>
926    
927     <div class="method-signature">
928     <span class="method-result"><a href="../../phpHtmlLib/SPANtag.html">object SPANtag</a></span>
929     <span class="method-name">
930     get_label
931     </span>
932     ()
933     </div>
934    
935    
936    
937     <hr class="separator" />
938     <div class="notes">Redefined in descendants as:</div>
939     <ul class="redefinitions">
940     <li>
941     <a href="../../phpHtmlLib/FormProcessing/FENumberInRange.html#methodget_label">FENumberInRange::get_label()</a>
942     </li>
943     </ul>
944     </div>
945     <a name="methodget_label_text" id="get_label_text"><!-- --></a>
946     <div class="oddrow">
947    
948     <div class="method-header">
949     <span class="method-title">get_label_text</span> (line <span class="line-number">146</span>)
950     </div>
951    
952     <!-- ========== Info from phpDoc block ========= -->
953     <p class="short-description">This function will return the elements label text</p>
954    
955     <div class="method-signature">
956     <span class="method-result">string</span>
957     <span class="method-name">
958     get_label_text
959     </span>
960     ()
961     </div>
962    
963    
964    
965     </div>
966     <a name="methodget_required_symbol" id="get_required_symbol"><!-- --></a>
967     <div class="evenrow">
968    
969     <div class="method-header">
970     <span class="method-title">get_required_symbol</span> (line <span class="line-number">589</span>)
971     </div>
972    
973     <!-- ========== Info from phpDoc block ========= -->
974     <p class="short-description">This function return the symbol used to denote a required field</p>
975     <ul class="tags">
976     <li><span class="field">return:</span> <p>- required symbol</p></li>
977     </ul>
978    
979     <div class="method-signature">
980     <span class="method-result">string</span>
981     <span class="method-name">
982     get_required_symbol
983     </span>
984     ()
985     </div>
986    
987    
988    
989     </div>
990     <a name="methodget_value" id="get_value"><!-- --></a>
991     <div class="oddrow">
992    
993     <div class="method-header">
994     <span class="method-title">get_value</span> (line <span class="line-number">166</span>)
995     </div>
996    
997     <!-- ========== Info from phpDoc block ========= -->
998     <p class="short-description">This function will return the elements value</p>
999    
1000     <div class="method-signature">
1001     <span class="method-result">mixed</span>
1002     <span class="method-name">
1003     get_value
1004     </span>
1005     ()
1006     </div>
1007    
1008    
1009    
1010     <hr class="separator" />
1011     <div class="notes">Redefined in descendants as:</div>
1012     <ul class="redefinitions">
1013     <li>
1014     <a href="../../phpHtmlLib/FormProcessing/FEFile.html#methodget_value">FEFile::get_value()</a>
1015     : This function will return the elements value
1016     </li>
1017     <li>
1018     <a href="../../phpHtmlLib/FormProcessing/FETextArea.html#methodget_value">FETextArea::get_value()</a>
1019     : This function will return the elements value
1020     </li>
1021     </ul>
1022     </div>
1023     <a name="methodget_value_text" id="get_value_text"><!-- --></a>
1024     <div class="evenrow">
1025    
1026     <div class="method-header">
1027     <span class="method-title">get_value_text</span> (line <span class="line-number">208</span>)
1028     </div>
1029    
1030     <!-- ========== Info from phpDoc block ========= -->
1031     <p class="short-description">This provides a method</p>
1032     <p class="description"><p>for the FormContent to get access to the text associated with a field. This is only available on FormElements that have text associated with a field. It is used during Confirmation</p></p>
1033     <ul class="tags">
1034     <li><span class="field">return:</span> <p>- the text associated</p></li>
1035     </ul>
1036    
1037     <div class="method-signature">
1038     <span class="method-result">string</span>
1039     <span class="method-name">
1040     get_value_text
1041     </span>
1042     (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
1043     </div>
1044    
1045     <ul class="parameters">
1046     <li>
1047     <span class="var-type">mixed</span>
1048     <span class="var-name">$value</span><span class="var-description">: <p>- the value to look up</p></span> </li>
1049     </ul>
1050    
1051    
1052     <hr class="separator" />
1053     <div class="notes">Redefined in descendants as:</div>
1054     <ul class="redefinitions">
1055     <li>
1056     <a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methodget_value_text">FEDataList::get_value_text()</a>
1057     : This provides a method
1058     </li>
1059     <li>
1060     <a href="../../phpHtmlLib/FormProcessing/FECheckBox.html#methodget_value_text">FECheckBox::get_value_text()</a>
1061     : This provides a method
1062     </li>
1063     <li>
1064     <a href="../../phpHtmlLib/FormProcessing/FERadioGroup.html#methodget_value_text">FERadioGroup::get_value_text()</a>
1065     : This provides a method
1066     </li>
1067     </ul>
1068     </div>
1069     <a name="methodhas_error" id="has_error"><!-- --></a>
1070     <div class="oddrow">
1071    
1072     <div class="method-header">
1073     <span class="method-title">has_error</span> (line <span class="line-number">374</span>)
1074     </div>
1075    
1076     <!-- ========== Info from phpDoc block ========= -->
1077     <p class="short-description">Returns the current error state</p>
1078     <ul class="tags">
1079     <li><span class="field">return:</span> <p>error state</p></li>
1080     </ul>
1081    
1082     <div class="method-signature">
1083     <span class="method-result">bool</span>
1084     <span class="method-name">
1085     has_error
1086     </span>
1087     ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$label</span> = <span class="var-default">NULL</span>])
1088     </div>
1089    
1090    
1091    
1092     </div>
1093     <a name="methodis_disabled" id="is_disabled"><!-- --></a>
1094     <div class="evenrow">
1095    
1096     <div class="method-header">
1097     <span class="method-title">is_disabled</span> (line <span class="line-number">260</span>)
1098     </div>
1099    
1100     <!-- ========== Info from phpDoc block ========= -->
1101     <p class="short-description">Returns the elements disabled state</p>
1102     <ul class="tags">
1103     <li><span class="field">return:</span> <p>disabled</p></li>
1104     </ul>
1105    
1106     <div class="method-signature">
1107     <span class="method-result">bool</span>
1108     <span class="method-name">
1109     is_disabled
1110     </span>
1111     ()
1112     </div>
1113    
1114    
1115    
1116     </div>
1117     <a name="methodis_required" id="is_required"><!-- --></a>
1118     <div class="oddrow">
1119    
1120     <div class="method-header">
1121     <span class="method-title">is_required</span> (line <span class="line-number">229</span>)
1122     </div>
1123    
1124     <!-- ========== Info from phpDoc block ========= -->
1125     <p class="short-description">Returns whether this elements final value cannot be empty</p>
1126     <ul class="tags">
1127     <li><span class="field">return:</span> <p>requried</p></li>
1128     </ul>
1129    
1130     <div class="method-signature">
1131     <span class="method-result">bool</span>
1132     <span class="method-name">
1133     is_required
1134     </span>
1135     ()
1136     </div>
1137    
1138    
1139    
1140     </div>
1141     <a name="methodjavascript" id="javascript"><!-- --></a>
1142     <div class="evenrow">
1143    
1144     <div class="method-header">
1145     <span class="method-title">javascript</span> (line <span class="line-number">486</span>)
1146     </div>
1147    
1148     <!-- ========== Info from phpDoc block ========= -->
1149     <p class="short-description">This method is used for adding any javascript that is used by this element. This will automatically get called and added to the page by the FormProcessor</p>
1150     <ul class="tags">
1151     <li><span class="field">return:</span> <p>- raw js</p></li>
1152     </ul>
1153    
1154     <div class="method-signature">
1155     <span class="method-result">string</span>
1156     <span class="method-name">
1157     javascript
1158     </span>
1159     ()
1160     </div>
1161    
1162    
1163    
1164     </div>
1165     <a name="methodonBlur" id="onBlur"><!-- --></a>
1166     <div class="oddrow">
1167    
1168     <div class="method-header">
1169     <span class="method-title">onBlur</span> (line <span class="line-number">526</span>)
1170     </div>
1171    
1172     <!-- ========== Info from phpDoc block ========= -->
1173     <p class="short-description">This function return the javaScript code for an onBlur event</p>
1174     <ul class="tags">
1175     <li><span class="field">return:</span> <p>- javascript code</p></li>
1176     </ul>
1177    
1178     <div class="method-signature">
1179     <span class="method-result">string</span>
1180     <span class="method-name">
1181     onBlur
1182     </span>
1183     ()
1184     </div>
1185    
1186    
1187    
1188     </div>
1189     <a name="methodonChange" id="onChange"><!-- --></a>
1190     <div class="evenrow">
1191    
1192     <div class="method-header">
1193     <span class="method-title">onChange</span> (line <span class="line-number">537</span>)
1194     </div>
1195    
1196     <!-- ========== Info from phpDoc block ========= -->
1197     <p class="short-description">this function retuns the javaScript code for an onChange event</p>
1198     <ul class="tags">
1199     <li><span class="field">return:</span> <p>- javascript code</p></li>
1200     </ul>
1201    
1202     <div class="method-signature">
1203     <span class="method-result">string</span>
1204     <span class="method-name">
1205     onChange
1206     </span>
1207     ()
1208     </div>
1209    
1210    
1211    
1212     </div>
1213     <a name="methodonClick" id="onClick"><!-- --></a>
1214     <div class="oddrow">
1215    
1216     <div class="method-header">
1217     <span class="method-title">onClick</span> (line <span class="line-number">496</span>)
1218     </div>
1219    
1220     <!-- ========== Info from phpDoc block ========= -->
1221     <p class="short-description">This function return the javaScript code for an onClick event</p>
1222     <ul class="tags">
1223     <li><span class="field">return:</span> <p>- javascript code</p></li>
1224     </ul>
1225    
1226     <div class="method-signature">
1227     <span class="method-result">string</span>
1228     <span class="method-name">
1229     onClick
1230     </span>
1231     ()
1232     </div>
1233    
1234    
1235    
1236     <hr class="separator" />
1237     <div class="notes">Redefined in descendants as:</div>
1238     <ul class="redefinitions">
1239     <li>
1240     <a href="../../phpHtmlLib/FormProcessing/FEButton.html#methodonClick">FEButton::onClick()</a>
1241     : This function return the javaScript code for an onClick event
1242     </li>
1243     <li>
1244     <a href="../../phpHtmlLib/FormProcessing/FESubmitButton.html#methodonClick">FESubmitButton::onClick()</a>
1245     : This function return the javaScript code for an onSubmit event
1246     </li>
1247     </ul>
1248     </div>
1249     <a name="methodonFocus" id="onFocus"><!-- --></a>
1250     <div class="evenrow">
1251    
1252     <div class="method-header">
1253     <span class="method-title">onFocus</span> (line <span class="line-number">506</span>)
1254     </div>
1255    
1256     <!-- ========== Info from phpDoc block ========= -->
1257     <p class="short-description">This function return the javaScript code for an onFocus event</p>
1258     <ul class="tags">
1259     <li><span class="field">return:</span> <p>- javascript code</p></li>
1260     </ul>
1261    
1262     <div class="method-signature">
1263     <span class="method-result">string</span>
1264     <span class="method-name">
1265     onFocus
1266     </span>
1267     ()
1268     </div>
1269    
1270    
1271    
1272     </div>
1273     <a name="methodonSubmit" id="onSubmit"><!-- --></a>
1274     <div class="oddrow">
1275    
1276     <div class="method-header">
1277     <span class="method-title">onSubmit</span> (line <span class="line-number">516</span>)
1278     </div>
1279    
1280     <!-- ========== Info from phpDoc block ========= -->
1281     <p class="short-description">This function return the javaScript code for an onSubmit event</p>
1282     <ul class="tags">
1283     <li><span class="field">return:</span> <p>- javascript code</p></li>
1284     </ul>
1285    
1286     <div class="method-signature">
1287     <span class="method-result">string</span>
1288     <span class="method-name">
1289     onSubmit
1290     </span>
1291     ()
1292     </div>
1293    
1294    
1295    
1296     </div>
1297     <a name="methodset_attribute" id="set_attribute"><!-- --></a>
1298     <div class="evenrow">
1299    
1300     <div class="method-header">
1301     <span class="method-title">set_attribute</span> (line <span class="line-number">285</span>)
1302     </div>
1303    
1304     <!-- ========== Info from phpDoc block ========= -->
1305     <p class="short-description">add a single attribute (name=&quot;value&quot;)</p>
1306    
1307     <div class="method-signature">
1308     <span class="method-result">void</span>
1309     <span class="method-name">
1310     set_attribute
1311     </span>
1312     (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">NULL</span>])
1313     </div>
1314    
1315     <ul class="parameters">
1316     <li>
1317     <span class="var-type">string</span>
1318     <span class="var-name">$name</span><span class="var-description">: <p>attribute name</p></span> </li>
1319     <li>
1320     <span class="var-type">mixed</span>
1321     <span class="var-name">$value</span><span class="var-description">: <p>the value</p></span> </li>
1322     </ul>
1323    
1324    
1325     </div>
1326     <a name="methodset_disabled" id="set_disabled"><!-- --></a>
1327     <div class="oddrow">
1328    
1329     <div class="method-header">
1330     <span class="method-title">set_disabled</span> (line <span class="line-number">250</span>)
1331     </div>
1332    
1333     <!-- ========== Info from phpDoc block ========= -->
1334     <p class="short-description">Sets the disabled element flag</p>
1335    
1336     <div class="method-signature">
1337     <span class="method-result">void</span>
1338     <span class="method-name">
1339     set_disabled
1340     </span>
1341     (<span class="var-type">bool</span>&nbsp;<span class="var-name">$flag</span>)
1342     </div>
1343    
1344     <ul class="parameters">
1345     <li>
1346     <span class="var-type">bool</span>
1347     <span class="var-name">$flag</span><span class="var-description">: <p>disabled</p></span> </li>
1348     </ul>
1349    
1350    
1351     </div>
1352     <a name="methodset_error_message" id="set_error_message"><!-- --></a>
1353     <div class="evenrow">
1354    
1355     <div class="method-header">
1356     <span class="method-title">set_error_message</span> (line <span class="line-number">338</span>)
1357     </div>
1358    
1359     <!-- ========== Info from phpDoc block ========= -->
1360     <p class="short-description">Defines error message text and sets the error flag to true</p>
1361    
1362     <div class="method-signature">
1363     <span class="method-result">void</span>
1364     <span class="method-name">
1365     set_error_message
1366     </span>
1367     (<span class="var-type">mesage</span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type">label</span>&nbsp;<span class="var-name">$label</span> = <span class="var-default">NULL</span>])
1368     </div>
1369    
1370     <ul class="parameters">
1371     <li>
1372     <span class="var-type">mesage</span>
1373     <span class="var-name">$message</span><span class="var-description">: <p>text - error message</p></span> </li>
1374     <li>
1375     <span class="var-type">label</span>
1376     <span class="var-name">$label</span><span class="var-description">: <p>text - a label to provide for the error. This is only needed for a complex element that has multiple 'hidden/magic' fields.</p></span> </li>
1377     </ul>
1378    
1379    
1380     </div>
1381     <a name="methodset_form_name" id="set_form_name"><!-- --></a>
1382     <div class="oddrow">
1383    
1384     <div class="method-header">
1385     <span class="method-title">set_form_name</span> (line <span class="line-number">191</span>)
1386     </div>
1387    
1388     <!-- ========== Info from phpDoc block ========= -->
1389     <p class="short-description">in case anyone in JS land needs the name of the form that this element lives in</p>
1390    
1391     <div class="method-signature">
1392     <span class="method-result">void</span>
1393     <span class="method-name">
1394     set_form_name
1395     </span>
1396     (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
1397     </div>
1398    
1399     <ul class="parameters">
1400     <li>
1401     <span class="var-type">string</span>
1402     <span class="var-name">$name</span><span class="var-description">: <p>- the form name</p></span> </li>
1403     </ul>
1404    
1405    
1406     </div>
1407     <a name="methodset_label_text" id="set_label_text"><!-- --></a>
1408     <div class="evenrow">
1409    
1410     <div class="method-header">
1411     <span class="method-title">set_label_text</span> (line <span class="line-number">156</span>)
1412     </div>
1413    
1414     <!-- ========== Info from phpDoc block ========= -->
1415     <p class="short-description">This function will set the label for the element</p>
1416    
1417     <div class="method-signature">
1418     <span class="method-result">void</span>
1419     <span class="method-name">
1420     set_label_text
1421     </span>
1422     (<span class="var-type">label</span>&nbsp;<span class="var-name">$label</span>)
1423     </div>
1424    
1425     <ul class="parameters">
1426     <li>
1427     <span class="var-type">label</span>
1428     <span class="var-name">$label</span><span class="var-description">: <p>string</p></span> </li>
1429     </ul>
1430    
1431    
1432     </div>
1433     <a name="methodset_required" id="set_required"><!-- --></a>
1434     <div class="oddrow">
1435    
1436     <div class="method-header">
1437     <span class="method-title">set_required</span> (line <span class="line-number">219</span>)
1438     </div>
1439    
1440     <!-- ========== Info from phpDoc block ========= -->
1441     <p class="short-description">This function set the elements required state</p>
1442    
1443     <div class="method-signature">
1444     <span class="method-result">void</span>
1445     <span class="method-name">
1446     set_required
1447     </span>
1448     (<span class="var-type">bool</span>&nbsp;<span class="var-name">$required</span>)
1449     </div>
1450    
1451     <ul class="parameters">
1452     <li>
1453     <span class="var-type">bool</span>
1454     <span class="var-name">$required</span><span class="var-description">: <p>required</p></span> </li>
1455     </ul>
1456    
1457    
1458     </div>
1459     <a name="methodset_stripslashes" id="set_stripslashes"><!-- --></a>
1460     <div class="evenrow">
1461    
1462     <div class="method-header">
1463     <span class="method-title">set_stripslashes</span> (line <span class="line-number">270</span>)
1464     </div>
1465    
1466     <!-- ========== Info from phpDoc block ========= -->
1467     <p class="short-description">This sets the stripslashes flag for this object.</p>
1468    
1469     <div class="method-signature">
1470     <span class="method-result">void</span>
1471     <span class="method-name">
1472     set_stripslashes
1473     </span>
1474     ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">TRUE</span>])
1475     </div>
1476    
1477     <ul class="parameters">
1478     <li>
1479     <span class="var-type">boolean</span>
1480     <span class="var-name">$flag</span> </li>
1481     </ul>
1482    
1483    
1484     </div>
1485     <a name="methodset_style_attribute" id="set_style_attribute"><!-- --></a>
1486     <div class="oddrow">
1487    
1488     <div class="method-header">
1489     <span class="method-title">set_style_attribute</span> (line <span class="line-number">320</span>)
1490     </div>
1491    
1492     <!-- ========== Info from phpDoc block ========= -->
1493     <p class="short-description">Sets elements css attribute</p>
1494    
1495     <div class="method-signature">
1496     <span class="method-result">void</span>
1497     <span class="method-name">
1498     set_style_attribute
1499     </span>
1500     (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
1501     </div>
1502    
1503     <ul class="parameters">
1504     <li>
1505     <span class="var-type">string</span>
1506     <span class="var-name">$name</span><span class="var-description">: <p>attribute name</p></span> </li>
1507     <li>
1508     <span class="var-type">mixed</span>
1509     <span class="var-name">$value</span><span class="var-description">: <p>the value</p></span> </li>
1510     </ul>
1511    
1512    
1513     </div>
1514     <a name="methodset_title" id="set_title"><!-- --></a>
1515     <div class="evenrow">
1516    
1517     <div class="method-header">
1518     <span class="method-title">set_title</span> (line <span class="line-number">310</span>)
1519     </div>
1520    
1521     <!-- ========== Info from phpDoc block ========= -->
1522     <p class="short-description">Sets elements title text</p>
1523    
1524     <div class="method-signature">
1525     <span class="method-result">void</span>
1526     <span class="method-name">
1527     set_title
1528     </span>
1529     (<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span>)
1530     </div>
1531    
1532     <ul class="parameters">
1533     <li>
1534     <span class="var-type">string</span>
1535     <span class="var-name">$title</span><span class="var-description">: <p>title</p></span> </li>
1536     </ul>
1537    
1538    
1539     </div>
1540     <a name="methodset_value" id="set_value"><!-- --></a>
1541     <div class="oddrow">
1542    
1543     <div class="method-header">
1544     <span class="method-title">set_value</span> (line <span class="line-number">180</span>)
1545     </div>
1546    
1547     <!-- ========== Info from phpDoc block ========= -->
1548     <p class="short-description">This function will set the initial value for the element</p>
1549    
1550     <div class="method-signature">
1551     <span class="method-result">void</span>
1552     <span class="method-name">
1553     set_value
1554     </span>
1555     (<span class="var-type">value</span>&nbsp;<span class="var-name">$value</span>)
1556     </div>
1557    
1558     <ul class="parameters">
1559     <li>
1560     <span class="var-type">value</span>
1561     <span class="var-name">$value</span><span class="var-description">: <p>mixed</p></span> </li>
1562     </ul>
1563    
1564    
1565     </div>
1566     <a name="methodvalidate" id="validate"><!-- --></a>
1567     <div class="evenrow">
1568    
1569     <div class="method-header">
1570     <span class="method-title">validate</span> (line <span class="line-number">439</span>)
1571     </div>
1572    
1573     <!-- ========== Info from phpDoc block ========= -->
1574     <p class="short-description">This function performs the actual validation It is called only if the validation is required by this element</p>
1575     <p class="description"><p>This function is responsible for performing complete validation and setting the appropriate error message in case of a failed validation</p></p>
1576    
1577     <div class="method-signature">
1578     <span class="method-result">void</span>
1579     <span class="method-name">
1580     validate
1581     </span>
1582     (<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>&nbsp;<span class="var-name">&$_FormValidation</span>)
1583     </div>
1584    
1585     <ul class="parameters">
1586     <li>
1587     <span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>
1588     <span class="var-name">&$_FormValidation</span><span class="var-description">: <p>object.</p></span> </li>
1589     </ul>
1590    
1591    
1592     <hr class="separator" />
1593     <div class="notes">Redefined in descendants as:</div>
1594     <ul class="redefinitions">
1595     <li>
1596     <a href="../../phpHtmlLib/FormProcessing/FENumber.html#methodvalidate">FENumber::validate()</a>
1597     : This method validates the data for this Form Element.
1598     </li>
1599     <li>
1600     <a href="../../phpHtmlLib/FormProcessing/FENumberFloat.html#methodvalidate">FENumberFloat::validate()</a>
1601     : This method validates the data for this Form Element.
1602     </li>
1603     <li>
1604     <a href="../../phpHtmlLib/FormProcessing/FENumberPrice.html#methodvalidate">FENumberPrice::validate()</a>
1605     : This method validates the data for this Form Element.
1606     </li>
1607     <li>
1608     <a href="../../phpHtmlLib/FormProcessing/FENumberInRange.html#methodvalidate">FENumberInRange::validate()</a>
1609     : This method validates the data for this Form Element.
1610     </li>
1611     <li>
1612     <a href="../../phpHtmlLib/FormProcessing/FEFile.html#methodvalidate">FEFile::validate()</a>
1613     : This method validates the data for this Form Element.
1614     </li>
1615     <li>
1616     <a href="../../phpHtmlLib/FormProcessing/FEName.html#methodvalidate">FEName::validate()</a>
1617     : This method validates the data for this Form Element.
1618     </li>
1619     <li>
1620     <a href="../../phpHtmlLib/FormProcessing/FEEmail.html#methodvalidate">FEEmail::validate()</a>
1621     : This method validates the data for this Form Element.
1622     </li>
1623     <li>
1624     <a href="../../phpHtmlLib/FormProcessing/FEEmailMany.html#methodvalidate">FEEmailMany::validate()</a>
1625     : This method validates the data for this Form Element.
1626     </li>
1627     <li>
1628     <a href="../../phpHtmlLib/FormProcessing/FEDomainName.html#methodvalidate">FEDomainName::validate()</a>
1629     : This method validates the data for this Form Element.
1630     </li>
1631     <li>
1632     <a href="../../phpHtmlLib/FormProcessing/FEHostNameWithPort.html#methodvalidate">FEHostNameWithPort::validate()</a>
1633     : This method validates the data for this Form Element.
1634     </li>
1635     <li>
1636     <a href="../../phpHtmlLib/FormProcessing/FEIPAddress.html#methodvalidate">FEIPAddress::validate()</a>
1637     : This method validates the data for this Form Element.
1638     </li>
1639     <li>
1640     <a href="../../phpHtmlLib/FormProcessing/FEUrl.html#methodvalidate">FEUrl::validate()</a>
1641     : This method validates the data for this Form Element.
1642     </li>
1643     <li>
1644     <a href="../../phpHtmlLib/FormProcessing/FEUrlStrict.html#methodvalidate">FEUrlStrict::validate()</a>
1645     : This method validates the data for this Form Element.
1646     </li>
1647     <li>
1648     <a href="../../phpHtmlLib/FormProcessing/FEPassword.html#methodvalidate">FEPassword::validate()</a>
1649     : This function performs the actual validation It is called only if the validation is required by this element
1650     </li>
1651     <li>
1652     <a href="../../phpHtmlLib/FormProcessing/FEConfirmPassword.html#methodvalidate">FEConfirmPassword::validate()</a>
1653     : This function performs the actual validation It is called only if the validation is required by this element
1654     </li>
1655     <li>
1656     <a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methodvalidate">FEDataList::validate()</a>
1657     : This function is responsible for performing complete validation and setting the appropriate error message in case of a failed validation
1658     </li>
1659     </ul>
1660     </div>
1661     <a name="method_build_element_attributes" id="_build_element_attributes"><!-- --></a>
1662     <div class="oddrow">
1663    
1664     <div class="method-header">
1665     <span class="method-title">_build_element_attributes</span> (line <span class="line-number">598</span>)
1666     </div>
1667    
1668     <!-- ========== Info from phpDoc block ========= -->
1669     <p class="short-description">This function builds the element form attributes</p>
1670     <ul class="tags">
1671     <li><span class="field">return:</span> <p>attributes</p></li>
1672     </ul>
1673    
1674     <div class="method-signature">
1675     <span class="method-result">array</span>
1676     <span class="method-name">
1677     _build_element_attributes
1678     </span>
1679     ()
1680     </div>
1681    
1682    
1683    
1684     </div>
1685     <a name="method_build_javascript" id="_build_javascript"><!-- --></a>
1686     <div class="evenrow">
1687    
1688     <div class="method-header">
1689     <span class="method-title">_build_javascript</span> (line <span class="line-number">547</span>)
1690     </div>
1691    
1692     <!-- ========== Info from phpDoc block ========= -->
1693     <p class="short-description">This function builds the complete javaScript events code for the element</p>
1694     <ul class="tags">
1695     <li><span class="field">return:</span> <p>- attributes</p></li>
1696     </ul>
1697    
1698     <div class="method-signature">
1699     <span class="method-result">array</span>
1700     <span class="method-name">
1701     _build_javascript
1702     </span>
1703     ()
1704     </div>
1705    
1706    
1707    
1708     </div>
1709     <a name="method_do_validation" id="_do_validation"><!-- --></a>
1710     <div class="oddrow">
1711    
1712     <div class="method-header">
1713     <span class="method-title">_do_validation</span> (line <span class="line-number">450</span>)
1714     </div>
1715    
1716     <!-- ========== Info from phpDoc block ========= -->
1717     <p class="short-description">This function checks if the validation is nesseccary and calls the validate method</p>
1718    
1719     <div class="method-signature">
1720     <span class="method-result">void</span>
1721     <span class="method-name">
1722     _do_validation
1723     </span>
1724     (<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>&nbsp;<span class="var-name">&$_FormValidation</span>)
1725     </div>
1726    
1727     <ul class="parameters">
1728     <li>
1729     <span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>
1730     <span class="var-name">&$_FormValidation</span><span class="var-description">: <p>object.</p></span> </li>
1731     </ul>
1732    
1733    
1734     </div>
1735    
1736     </div>
1737     </div>
1738    
1739     <p class="notes" id="credit">
1740     Documention generated on Thu, 31 Jul 2003 18:32:43 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
1741     </p>
1742     </div></body>
1743 jonen 1.1 </html>

MailToCvsAdmin">MailToCvsAdmin
ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed