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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (show annotations)
Thu May 6 16:57:07 2004 UTC (20 years, 8 months ago) by jonen
Branch: MAIN
CVS Tags: HEAD
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 FEDate</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 FEDate</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
21 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
22
23 </div>
24 <div class="info-box-body">
25 <!-- ========== Info from phpDoc block ========= -->
26 <p class="short-description">This class builds a FEDataList that shows a group of select boxes (FEYears, FEMonths, FEDays) representing a date.</p>
27 <ul class="tags">
28 <li><span class="field">copyright:</span> LGPL - See LICENCE</li>
29 <li><span class="field">author:</span> Culley Harrelson &lt;<a href="mailto:culley@fastmail.fm">culley@fastmail.fm</a>&gt;</li>
30 <li><span class="field">author:</span> Suren Markosian &lt;<a href="mailto:suren@emicron.net">suren@emicron.net</a>&gt;</li>
31 </ul>
32 <p class="notes">
33 Located in <a class="field" href="_form_form_elements_FEListBox_inc.html">/form/form_elements/FEListBox.inc</a> (line <span class="field">896</span>)
34 </p>
35
36
37 <pre><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a>
38 |
39 --<a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a>
40 |
41 --FEDate</pre>
42
43 </div>
44 </div>
45
46
47
48 <a name="sec-var-summary"></a>
49 <div class="info-box">
50 <div class="info-box-title">Variable Summary</span></div>
51 <div class="nav-bar">
52 <a href="#sec-description">Description</a> |
53 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
54 |
55 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
56
57 </div>
58 <div class="info-box-body">
59 <div class="var-summary">
60 <div class="var-title">
61 <span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FEDays.html">FEDays</a></span>
62 <a href="#$_day" title="details" class="var-name">$_day</a>
63 </div>
64 <div class="var-title">
65 <span class="var-type">string</span>
66 <a href="#$_format" title="details" class="var-name">$_format</a>
67 </div>
68 <div class="var-title">
69 <span class="var-type">string</span>
70 <a href="#$_max_year" title="details" class="var-name">$_max_year</a>
71 </div>
72 <div class="var-title">
73 <span class="var-type">int</span>
74 <a href="#$_min_year" title="details" class="var-name">$_min_year</a>
75 </div>
76 <div class="var-title">
77 <span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FEMonths.html">FEMonths</a></span>
78 <a href="#$_month" title="details" class="var-name">$_month</a>
79 </div>
80 <div class="var-title">
81 <span class="var-type">string</span>
82 <a href="#$_text_format" title="details" class="var-name">$_text_format</a>
83 </div>
84 <div class="var-title">
85 <span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FEYears.html">FEYears</a></span>
86 <a href="#$_year" title="details" class="var-name">$_year</a>
87 </div>
88 </div>
89 </div>
90 </div>
91
92 <a name="sec-method-summary"></a>
93 <div class="info-box">
94 <div class="info-box-title">Method Summary</span></div>
95 <div class="nav-bar">
96 <a href="#sec-description">Description</a> |
97 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
98
99 |
100 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
101 </div>
102 <div class="info-box-body">
103 <div class="method-summary">
104
105 <div class="method-definition">
106 <span class="method-result">FEDate</span>
107 <a href="#FEDate" title="details" class="method-name">FEDate</a>
108 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$required</span> = <span class="var-default">TRUE</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">NULL</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$height</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$format</span> = <span class="var-default">'mdy'</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$min_year</span> = <span class="var-default">2000</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$max_year</span> = <span class="var-default">2010</span>])
109 </div>
110
111 <div class="method-definition">
112 <span class="method-result">container</span>
113 <a href="#get_confirm_element" title="details" class="method-name">get_confirm_element</a>
114 ()
115 </div>
116
117 <div class="method-definition">
118 <span class="method-result">object</span>
119 <a href="#get_element" title="details" class="method-name">get_element</a>
120 ()
121 </div>
122
123 <div class="method-definition">
124 <span class="method-result">array</span>
125 <a href="#get_value" title="details" class="method-name">get_value</a>
126 ()
127 </div>
128
129 <div class="method-definition">
130 <span class="method-result">string</span>
131 <a href="#get_value_text" title="details" class="method-name">get_value_text</a>
132 ()
133 </div>
134
135 <div class="method-definition">
136 <span class="method-result">void</span>
137 <a href="#set_text_format" title="details" class="method-name">set_text_format</a>
138 (<span class="var-type">string</span>&nbsp;<span class="var-name">$format</span>)
139 </div>
140
141 <div class="method-definition">
142 <span class="method-result">void</span>
143 <a href="#set_value" title="details" class="method-name">set_value</a>
144 (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
145 </div>
146
147 <div class="method-definition">
148 <span class="method-result">void</span>
149 <a href="#validate" title="details" class="method-name">validate</a>
150 (<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>&nbsp;<span class="var-name">&$_FormValidation</span>)
151 </div>
152
153 <div class="method-definition">
154 <span class="method-result">bool</span>
155 <a href="#_set_format" title="details" class="method-name">_set_format</a>
156 (<span class="var-type">string</span>&nbsp;<span class="var-name">$format</span>)
157 </div>
158 </div>
159 </div>
160 </div>
161
162 <a name="sec-vars"></a>
163 <div class="info-box">
164 <div class="info-box-title">Variables</div>
165 <div class="nav-bar">
166 <a href="#sec-description">Description</a> |
167 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
168
169
170 |
171 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
172
173 </div>
174 <div class="info-box-body">
175 <a name="var$_day" id="$_day"><!-- --></A>
176 <div class="evenrow">
177
178 <div class="var-header">
179 <span class="var-title">
180 <span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FEDays.html">FEDays</a></span>
181 <span class="var-name">$_day</span>
182 (line <span class="line-number">946</span>)
183 </span>
184 </div>
185
186 <!-- ========== Info from phpDoc block ========= -->
187 <p class="short-description">The day form element</p>
188
189
190
191
192
193 </div>
194 <a name="var$_format" id="$_format"><!-- --></A>
195 <div class="oddrow">
196
197 <div class="var-header">
198 <span class="var-title">
199 <span class="var-type">string</span>
200 <span class="var-name">$_format</span>
201 = <span class="var-default"> 'mdy'</span> (line <span class="line-number">916</span>)
202 </span>
203 </div>
204
205 <!-- ========== Info from phpDoc block ========= -->
206 <p class="short-description">The order in which to show the elements. This variable must be 3 characters long and contain only one m only one d and only one y.</p>
207
208
209
210
211
212 </div>
213 <a name="var$_max_year" id="$_max_year"><!-- --></A>
214 <div class="evenrow">
215
216 <div class="var-header">
217 <span class="var-title">
218 <span class="var-type">string</span>
219 <span class="var-name">$_max_year</span>
220 (line <span class="line-number">908</span>)
221 </span>
222 </div>
223
224 <!-- ========== Info from phpDoc block ========= -->
225 <p class="short-description">The latest year shown in the year list.</p>
226
227
228
229
230
231 </div>
232 <a name="var$_min_year" id="$_min_year"><!-- --></A>
233 <div class="oddrow">
234
235 <div class="var-header">
236 <span class="var-title">
237 <span class="var-type">int</span>
238 <span class="var-name">$_min_year</span>
239 (line <span class="line-number">902</span>)
240 </span>
241 </div>
242
243 <!-- ========== Info from phpDoc block ========= -->
244 <p class="short-description">The earliest year shown in the year list.</p>
245
246
247
248
249
250 </div>
251 <a name="var$_month" id="$_month"><!-- --></A>
252 <div class="evenrow">
253
254 <div class="var-header">
255 <span class="var-title">
256 <span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FEMonths.html">FEMonths</a></span>
257 <span class="var-name">$_month</span>
258 (line <span class="line-number">939</span>)
259 </span>
260 </div>
261
262 <!-- ========== Info from phpDoc block ========= -->
263 <p class="short-description">The month form element</p>
264
265
266
267
268
269 </div>
270 <a name="var$_text_format" id="$_text_format"><!-- --></A>
271 <div class="oddrow">
272
273 <div class="var-header">
274 <span class="var-title">
275 <span class="var-type">string</span>
276 <span class="var-name">$_text_format</span>
277 = <span class="var-default"> '%s %s %s'</span> (line <span class="line-number">925</span>)
278 </span>
279 </div>
280
281 <!-- ========== Info from phpDoc block ========= -->
282 <p class="short-description">A printf style format string used to add punctuation to the confirmation display. Defaults to space separated. The placeholders are filled according to the order set in $_format</p>
283
284
285
286
287
288 </div>
289 <a name="var$_year" id="$_year"><!-- --></A>
290 <div class="evenrow">
291
292 <div class="var-header">
293 <span class="var-title">
294 <span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FEYears.html">FEYears</a></span>
295 <span class="var-name">$_year</span>
296 (line <span class="line-number">932</span>)
297 </span>
298 </div>
299
300 <!-- ========== Info from phpDoc block ========= -->
301 <p class="short-description">The year form element</p>
302
303
304
305
306
307 </div>
308
309 <h4>Inherited Variables</h4>
310 <A NAME='inherited_vars'><!-- --></A>
311 <p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></span></p>
312 <blockquote>
313 <span class="var-title">
314 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_height">FEBoxElement::$_height</a></span><br>
315 </span>
316 <span class="var-title">
317 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_width">FEBoxElement::$_width</a></span><br>
318 </span>
319 </blockquote>
320 <p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
321 <blockquote>
322 <span class="var-title">
323 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></span><br>
324 </span>
325 <span class="var-title">
326 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></span><br>
327 </span>
328 <span class="var-title">
329 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_errors">FormElement::$_errors</a></span><br>
330 </span>
331 <span class="var-title">
332 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></span><br>
333 </span>
334 <span class="var-title">
335 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_form_name">FormElement::$_form_name</a></span><br>
336 </span>
337 <span class="var-title">
338 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></span><br>
339 </span>
340 <span class="var-title">
341 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_form_on_submit">FormElement::$_has_form_on_submit</a></span><br>
342 </span>
343 <span class="var-title">
344 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></span><br>
345 </span>
346 <span class="var-title">
347 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></span><br>
348 </span>
349 <span class="var-title">
350 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></span><br>
351 </span>
352 <span class="var-title">
353 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_required_field_marker">FormElement::$_required_field_marker</a></span><br>
354 </span>
355 <span class="var-title">
356 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_slave_elements">FormElement::$_slave_elements</a></span><br>
357 </span>
358 <span class="var-title">
359 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_stripslashes">FormElement::$_stripslashes</a></span><br>
360 </span>
361 <span class="var-title">
362 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></span><br>
363 </span>
364 <span class="var-title">
365 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></span><br>
366 </span>
367 </blockquote>
368
369 </div>
370 </div>
371
372 <a name="sec-methods"></a>
373 <div class="info-box">
374 <div class="info-box-title">Methods</div>
375 <div class="nav-bar">
376 <a href="#sec-description">Description</a> |
377 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
378 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
379
380 </div>
381 <div class="info-box-body">
382 <A NAME='method_detail'></A>
383 <a name="methodFEDate" id="FEDate"><!-- --></a>
384 <div class="oddrow">
385
386 <div class="method-header">
387 <span class="method-title">Constructor FEDate</span> (line <span class="line-number">961</span>)
388 </div>
389
390 <!-- ========== Info from phpDoc block ========= -->
391 <p class="short-description">The constructor</p>
392
393 <div class="method-signature">
394 <span class="method-result">FEDate</span>
395 <span class="method-name">
396 FEDate
397 </span>
398 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$required</span> = <span class="var-default">TRUE</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">NULL</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$height</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$format</span> = <span class="var-default">'mdy'</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$min_year</span> = <span class="var-default">2000</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$max_year</span> = <span class="var-default">2010</span>])
399 </div>
400
401 <ul class="parameters">
402 <li>
403 <span class="var-type">string</span>
404 <span class="var-name">$label</span><span class="var-description">: text label for the element</span> </li>
405 <li>
406 <span class="var-type">boolean</span>
407 <span class="var-name">$required</span><span class="var-description">: is this a required element?</span> </li>
408 <li>
409 <span class="var-type">int</span>
410 <span class="var-name">$width</span><span class="var-description">: element width in characters, pixels (px), percentage (%) or elements (em)</span> </li>
411 <li>
412 <span class="var-type">int</span>
413 <span class="var-name">$height</span><span class="var-description">: element height in px</span> </li>
414 <li>
415 <span class="var-type">string</span>
416 <span class="var-name">$format</span><span class="var-description">: date format string. M m F Y y d D are valid. 3 characters max.</span> </li>
417 <li>
418 <span class="var-type">int</span>
419 <span class="var-name">$min_year</span><span class="var-description">: min value for year drop down list</span> </li>
420 <li>
421 <span class="var-type">int</span>
422 <span class="var-name">$max_year</span><span class="var-description">: max value for year drop down list</span> </li>
423 </ul>
424
425
426 </div>
427 <a name="methodget_confirm_element" id="get_confirm_element"><!-- --></a>
428 <div class="evenrow">
429
430 <div class="method-header">
431 <span class="method-title">get_confirm_element</span> (line <span class="line-number">1150</span>)
432 </div>
433
434 <!-- ========== Info from phpDoc block ========= -->
435 <p class="short-description">This method returns the hidden version of this element for a confirmation page.</p>
436 <p class="description"><p>NOTE: This is called by the FormProcessor only. It shouldn't be called manually.</p></p>
437
438 <div class="method-signature">
439 <span class="method-result">container</span>
440 <span class="method-name">
441 get_confirm_element
442 </span>
443 ()
444 </div>
445
446
447 <hr class="separator" />
448 <div class="notes">Redefinition of:</div>
449 <dl>
450 <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_confirm_element">FormElement::get_confirm_element()</a></dt>
451 <dd>This method returns the hidden version of this element for a confirmation page.</dd>
452 </dl>
453
454 </div>
455 <a name="methodget_element" id="get_element"><!-- --></a>
456 <div class="oddrow">
457
458 <div class="method-header">
459 <span class="method-title">get_element</span> (line <span class="line-number">979</span>)
460 </div>
461
462 <!-- ========== Info from phpDoc block ========= -->
463 <p class="short-description">This function builds and returns the form element object</p>
464
465 <div class="method-signature">
466 <span class="method-result">object</span>
467 <span class="method-name">
468 get_element
469 </span>
470 ()
471 </div>
472
473
474 <hr class="separator" />
475 <div class="notes">Redefinition of:</div>
476 <dl>
477 <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></dt>
478 <dd>This function builds and returns the form element object</dd>
479 </dl>
480
481 </div>
482 <a name="methodget_value" id="get_value"><!-- --></a>
483 <div class="evenrow">
484
485 <div class="method-header">
486 <span class="method-title">get_value</span> (line <span class="line-number">1009</span>)
487 </div>
488
489 <!-- ========== Info from phpDoc block ========= -->
490 <p class="short-description">This function will return the elements value as an array or month, day and year</p>
491
492 <div class="method-signature">
493 <span class="method-result">array</span>
494 <span class="method-name">
495 get_value
496 </span>
497 ()
498 </div>
499
500
501 <hr class="separator" />
502 <div class="notes">Redefinition of:</div>
503 <dl>
504 <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></dt>
505 <dd>This function will return the elements value</dd>
506 </dl>
507
508 </div>
509 <a name="methodget_value_text" id="get_value_text"><!-- --></a>
510 <div class="oddrow">
511
512 <div class="method-header">
513 <span class="method-title">get_value_text</span> (line <span class="line-number">1037</span>)
514 </div>
515
516 <!-- ========== Info from phpDoc block ========= -->
517 <p class="short-description">This returns a formatted string used for the confirmation display (and possibly elsewhere)</p>
518
519 <div class="method-signature">
520 <span class="method-result">string</span>
521 <span class="method-name">
522 get_value_text
523 </span>
524 ()
525 </div>
526
527
528 <hr class="separator" />
529 <div class="notes">Redefinition of:</div>
530 <dl>
531 <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></dt>
532 <dd>This provides a method</dd>
533 </dl>
534
535 </div>
536 <a name="methodset_text_format" id="set_text_format"><!-- --></a>
537 <div class="evenrow">
538
539 <div class="method-header">
540 <span class="method-title">set_text_format</span> (line <span class="line-number">1136</span>)
541 </div>
542
543 <!-- ========== Info from phpDoc block ========= -->
544 <p class="short-description">this method sets the format string used in get_value_text(). Use this method to set special punctuation for the confirmation display.</p>
545
546 <div class="method-signature">
547 <span class="method-result">void</span>
548 <span class="method-name">
549 set_text_format
550 </span>
551 (<span class="var-type">string</span>&nbsp;<span class="var-name">$format</span>)
552 </div>
553
554 <ul class="parameters">
555 <li>
556 <span class="var-type">string</span>
557 <span class="var-name">$format</span> </li>
558 </ul>
559
560
561 </div>
562 <a name="methodset_value" id="set_value"><!-- --></a>
563 <div class="oddrow">
564
565 <div class="method-header">
566 <span class="method-title">set_value</span> (line <span class="line-number">1022</span>)
567 </div>
568
569 <!-- ========== Info from phpDoc block ========= -->
570 <p class="short-description">This function sets the default values for the date element The parameter should be a string representation of the date in ISO 8601 format.</p>
571
572 <div class="method-signature">
573 <span class="method-result">void</span>
574 <span class="method-name">
575 set_value
576 </span>
577 (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
578 </div>
579
580 <ul class="parameters">
581 <li>
582 <span class="var-type">string</span>
583 <span class="var-name">$value</span> </li>
584 </ul>
585
586 <hr class="separator" />
587 <div class="notes">Redefinition of:</div>
588 <dl>
589 <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></dt>
590 <dd>This function will set the initial value for the element</dd>
591 </dl>
592
593 </div>
594 <a name="methodvalidate" id="validate"><!-- --></a>
595 <div class="evenrow">
596
597 <div class="method-header">
598 <span class="method-title">validate</span> (line <span class="line-number">1084</span>)
599 </div>
600
601 <!-- ========== Info from phpDoc block ========= -->
602 <p class="short-description">This function is responsible for performing complete validation and setting the appropriate error message in case of a failed validation</p>
603
604 <div class="method-signature">
605 <span class="method-result">void</span>
606 <span class="method-name">
607 validate
608 </span>
609 (<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>&nbsp;<span class="var-name">&$_FormValidation</span>)
610 </div>
611
612 <ul class="parameters">
613 <li>
614 <span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>
615 <span class="var-name">&$_FormValidation</span><span class="var-description">: object</span> </li>
616 </ul>
617
618 <hr class="separator" />
619 <div class="notes">Redefinition of:</div>
620 <dl>
621 <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></dt>
622 <dd>This function performs the actual validation It is called only if the validation is required by this element</dd>
623 </dl>
624
625 </div>
626 <a name="method_set_format" id="_set_format"><!-- --></a>
627 <div class="oddrow">
628
629 <div class="method-header">
630 <span class="method-title">_set_format</span> (line <span class="line-number">1101</span>)
631 </div>
632
633 <!-- ========== Info from phpDoc block ========= -->
634 <p class="short-description">this method sets the display order for the elements in the widget</p>
635 <ul class="tags">
636 <li><span class="field">return:</span> success or failure</li>
637 </ul>
638
639 <div class="method-signature">
640 <span class="method-result">bool</span>
641 <span class="method-name">
642 _set_format
643 </span>
644 (<span class="var-type">string</span>&nbsp;<span class="var-name">$format</span>)
645 </div>
646
647 <ul class="parameters">
648 <li>
649 <span class="var-type">string</span>
650 <span class="var-name">$format</span> </li>
651 </ul>
652
653
654 </div>
655 <h4>Inherited Methods</h4>
656 <a name='inherited_methods'><!-- --></a>
657 <!-- =========== Summary =========== -->
658 <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></span></p>
659 <blockquote>
660 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#methodFEBoxElement">FEBoxElement::FEBoxElement()</a></span><br>
661 </blockquote>
662 <!-- =========== Summary =========== -->
663 <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
664 <blockquote>
665 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></span><br>
666 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></span><br>
667 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodform_tag_onsubmit">FormElement::form_tag_onsubmit()</a></span><br>
668 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></span><br>
669 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_confirm_element">FormElement::get_confirm_element()</a></span><br>
670 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></span><br>
671 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></span><br>
672 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_errors">FormElement::get_errors()</a></span><br>
673 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></span><br>
674 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></span><br>
675 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></span><br>
676 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></span><br>
677 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></span><br>
678 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_slave_elements">FormElement::get_slave_elements()</a></span><br>
679 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_tabindex">FormElement::get_tabindex()</a></span><br>
680 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></span><br>
681 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></span><br>
682 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></span><br>
683 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></span><br>
684 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></span><br>
685 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodjavascript">FormElement::javascript()</a></span><br>
686 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></span><br>
687 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonChange">FormElement::onChange()</a></span><br>
688 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></span><br>
689 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></span><br>
690 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></span><br>
691 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></span><br>
692 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_data_all_slaves">FormElement::set_data_all_slaves()</a></span><br>
693 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></span><br>
694 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_element_name">FormElement::set_element_name()</a></span><br>
695 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></span><br>
696 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_form_name">FormElement::set_form_name()</a></span><br>
697 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></span><br>
698 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></span><br>
699 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required_symbol">FormElement::set_required_symbol()</a></span><br>
700 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_slave_data">FormElement::set_slave_data()</a></span><br>
701 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_slave_elements">FormElement::set_slave_elements()</a></span><br>
702 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_stripslashes">FormElement::set_stripslashes()</a></span><br>
703 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></span><br>
704 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_tabindex">FormElement::set_tabindex()</a></span><br>
705 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></span><br>
706 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></span><br>
707 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></span><br>
708 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></span><br>
709 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></span><br>
710 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></span><br>
711 </blockquote>
712
713 </div>
714 </div>
715
716
717 <p class="notes" id="credit">
718 Documentation generated on Thu, 1 Apr 2004 09:38:24 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a>
719 </p>
720 </div></body>
721 </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed