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

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

Parent Directory Parent Directory | Revision Log Revision Log

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