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