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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (show annotations)
Wed Sep 24 13:11:47 2003 UTC (21 years ago) by jonen
Branch: MAIN
File MIME type: text/html 
+ updated whole phphtmllib to v2.3.0
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 FENumberInRange</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 FENumberInRange</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 is the Number Range FormElement which builds a text input field.</p>
26 <p class="description"><p>It validates as is_within_rage().</p></p>
27 <ul class="tags">
28 <li><span class="field">copyright:</span> <p>LGPL - See LICENCE</p></li>
29 <li><span class="field">author:</span> <p>Suren Markossian &lt;<a href="mailto:suren@bcsweb.com">mailto:suren@bcsweb.com</a>&gt;</p></li>
30 <li><span class="field">author:</span> <p>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</p></li>
31 </ul>
32 <p class="notes">
33 Located in <a class="field" href="_form_form_elements_FENumbers_inc.html">Program_Root/form/form_elements/FENumbers.inc</a> (line <span class="field">126</span>)
34 </p>
35
36
37 <pre><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a>
38 |
39 --<a href="../../phpHtmlLib/FormProcessing/FEText.html">FEText</a>
40 |
41 --FENumberInRange</pre>
42
43 </div>
44 </div>
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">mixed</span>
61 <a href="#$_label_flag" title="details" class="var-name">$_label_flag</a>
62 </div>
63 <div class="var-title">
64 <span class="var-type">mixed</span>
65 <a href="#$_max" title="details" class="var-name">$_max</a>
66 </div>
67 <div class="var-title">
68 <span class="var-type">mixed</span>
69 <a href="#$_min" title="details" class="var-name">$_min</a>
70 </div>
71 </div>
72 </div>
73 </div>
74
75 <a name="sec-method-summary"></a>
76 <div class="info-box">
77 <div class="info-box-title">Method Summary</span></div>
78 <div class="nav-bar">
79 <a href="#sec-description">Description</a> |
80 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
81
82 |
83 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
84 </div>
85 <div class="info-box-body">
86 <div class="method-summary">
87
88 <div class="method-definition">
89 <span class="method-result">void</span>
90 <a href="#FENumberInRange" title="details" class="method-name">FENumberInRange</a>
91 (<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>], [<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">$maxlength</span> = <span class="var-default">NULL</span>], <span class="var-type">int</span>&nbsp;<span class="var-name">$min</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$max</span> = <span class="var-default">100</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$label_flag</span> = <span class="var-default">TRUE</span>])
92 </div>
93
94 <div class="method-definition">
95 <span class="method-result">void</span>
96 <a href="#get_label" title="details" class="method-name">get_label</a>
97 ()
98 </div>
99
100 <div class="method-definition">
101 <span class="method-result">void</span>
102 <a href="#validate" title="details" class="method-name">validate</a>
103 (<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>&nbsp;<span class="var-name">&$_FormValidation</span>)
104 </div>
105 </div>
106 </div>
107 </div>
108
109 <a name="sec-vars"></a>
110 <div class="info-box">
111 <div class="info-box-title">Variables</div>
112 <div class="nav-bar">
113 <a href="#sec-description">Description</a> |
114 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
115
116
117 |
118 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
119
120 </div>
121 <div class="info-box-body">
122 <a name="var$_label_flag" id="$_label_flag"><!-- --></A>
123 <div class="evenrow">
124
125 <div class="var-header">
126 <span class="var-title">
127 <span class="var-type">mixed</span>
128 <span class="var-name">$_label_flag</span>
129 = <span class="var-default"> TRUE</span> (line <span class="line-number">140</span>)
130 </span>
131 </div>
132
133 <!-- ========== Info from phpDoc block ========= -->
134 <p class="short-description">Add the range to the label automatically?</p>
135
136
137
138
139
140 </div>
141 <a name="var$_max" id="$_max"><!-- --></A>
142 <div class="oddrow">
143
144 <div class="var-header">
145 <span class="var-title">
146 <span class="var-type">mixed</span>
147 <span class="var-name">$_max</span>
148 = <span class="var-default"> 100</span> (line <span class="line-number">135</span>)
149 </span>
150 </div>
151
152 <!-- ========== Info from phpDoc block ========= -->
153 <p class="short-description">The maximum #</p>
154
155
156
157
158
159 </div>
160 <a name="var$_min" id="$_min"><!-- --></A>
161 <div class="evenrow">
162
163 <div class="var-header">
164 <span class="var-title">
165 <span class="var-type">mixed</span>
166 <span class="var-name">$_min</span>
167 = <span class="var-default"> 0</span> (line <span class="line-number">131</span>)
168 </span>
169 </div>
170
171 <!-- ========== Info from phpDoc block ========= -->
172 <p class="short-description">The minimum #</p>
173
174
175
176
177
178 </div>
179 <h4>Inherited Variables</h4>
180 <A NAME='inherited_vars'><!-- --></A>
181 <p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
182 <blockquote>
183 <span class="var-title">
184 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></span><br>
185 </span>
186 <span class="var-title">
187 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></span><br>
188 </span>
189 <span class="var-title">
190 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_errors">FormElement::$_errors</a></span><br>
191 </span>
192 <span class="var-title">
193 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></span><br>
194 </span>
195 <span class="var-title">
196 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_form_name">FormElement::$_form_name</a></span><br>
197 </span>
198 <span class="var-title">
199 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></span><br>
200 </span>
201 <span class="var-title">
202 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></span><br>
203 </span>
204 <span class="var-title">
205 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></span><br>
206 </span>
207 <span class="var-title">
208 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></span><br>
209 </span>
210 <span class="var-title">
211 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_stripslashes">FormElement::$_stripslashes</a></span><br>
212 </span>
213 <span class="var-title">
214 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></span><br>
215 </span>
216 <span class="var-title">
217 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></span><br>
218 </span>
219 </blockquote>
220
221 </div>
222 </div>
223
224 <a name="sec-methods"></a>
225 <div class="info-box">
226 <div class="info-box-title">Methods</div>
227 <div class="nav-bar">
228 <a href="#sec-description">Description</a> |
229 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
230 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
231
232 </div>
233 <div class="info-box-body">
234 <A NAME='method_detail'></A>
235 <a name="methodFENumberInRange" id="FENumberInRange"><!-- --></a>
236 <div class="oddrow">
237
238 <div class="method-header">
239 <span class="method-title">Constructor FENumberInRange</span> (line <span class="line-number">154</span>)
240 </div>
241
242 <!-- ========== Info from phpDoc block ========= -->
243 <p class="short-description">The constructor</p>
244
245 <div class="method-signature">
246 <span class="method-result">void</span>
247 <span class="method-name">
248 FENumberInRange
249 </span>
250 (<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>], [<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">$maxlength</span> = <span class="var-default">NULL</span>], <span class="var-type">int</span>&nbsp;<span class="var-name">$min</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$max</span> = <span class="var-default">100</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$label_flag</span> = <span class="var-default">TRUE</span>])
251 </div>
252
253 <ul class="parameters">
254 <li>
255 <span class="var-type">label</span>
256 <span class="var-name">$label</span><span class="var-description">: <p>string - text label for the element</p></span> </li>
257 <li>
258 <span class="var-type">bool</span>
259 <span class="var-name">$required</span><span class="var-description">: <p>required - is this a required element</p></span> </li>
260 <li>
261 <span class="var-type">int</span>
262 <span class="var-name">$width</span><span class="var-description">: <p>required - element width in characters, pixels (px), percentage (%) or elements (em)</p></span> </li>
263 <li>
264 <span class="var-type">int</span>
265 <span class="var-name">$maxlength</span><span class="var-description">: <p>maximum number of chars allowed to type in the field</p></span> </li>
266 <li>
267 <span class="var-type">int</span>
268 <span class="var-name">$min</span><span class="var-description">: <p>the minimum value allowable</p></span> </li>
269 <li>
270 <span class="var-type">int</span>
271 <span class="var-name">$max</span><span class="var-description">: <p>the maximum value allowable</p></span> </li>
272 <li>
273 <span class="var-type">boolean</span>
274 <span class="var-name">$label_flag</span><span class="var-description">: <p>- add the range to the label automatically?</p></span> </li>
275 </ul>
276
277
278 </div>
279 <a name="methodget_label" id="get_label"><!-- --></a>
280 <div class="evenrow">
281
282 <div class="method-header">
283 <span class="method-title">get_label</span> (line <span class="line-number">162</span>)
284 </div>
285
286 <!-- ========== Info from phpDoc block ========= -->
287
288 <div class="method-signature">
289 <span class="method-result">void</span>
290 <span class="method-name">
291 get_label
292 </span>
293 ()
294 </div>
295
296
297 <hr class="separator" />
298 <div class="notes">Redefinition of:</div>
299 <dl>
300 <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></dt>
301 <dd>This function builds and returns a label object based on the label text and error conditions</dd>
302 </dl>
303
304 </div>
305 <a name="methodvalidate" id="validate"><!-- --></a>
306 <div class="oddrow">
307
308 <div class="method-header">
309 <span class="method-title">validate</span> (line <span class="line-number">188</span>)
310 </div>
311
312 <!-- ========== Info from phpDoc block ========= -->
313 <p class="short-description">This method validates the data for this Form Element.</p>
314 <p class="description"><p>It validates as is_price().</p></p>
315
316 <div class="method-signature">
317 <span class="method-result">void</span>
318 <span class="method-name">
319 validate
320 </span>
321 (<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>&nbsp;<span class="var-name">&$_FormValidation</span>)
322 </div>
323
324 <ul class="parameters">
325 <li>
326 <span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>
327 <span class="var-name">&$_FormValidation</span><span class="var-description">: <p>object.</p></span> </li>
328 </ul>
329
330 <hr class="separator" />
331 <div class="notes">Redefinition of:</div>
332 <dl>
333 <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></dt>
334 <dd>This function performs the actual validation It is called only if the validation is required by this element</dd>
335 </dl>
336
337 </div>
338 <h4>Inherited Methods</h4>
339 <a name='inherited_methods'><!-- --></a>
340 <!-- =========== Summary =========== -->
341 <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEText.html">FEText</a></span></p>
342 <blockquote>
343 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEText.html#methodFEText">FEText::FEText()</a></span><br>
344 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEText.html#methodget_element">FEText::get_element()</a></span><br>
345 </blockquote>
346 <!-- =========== Summary =========== -->
347 <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
348 <blockquote>
349 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></span><br>
350 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></span><br>
351 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></span><br>
352 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></span><br>
353 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></span><br>
354 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_errors">FormElement::get_errors()</a></span><br>
355 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></span><br>
356 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></span><br>
357 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></span><br>
358 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></span><br>
359 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></span><br>
360 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></span><br>
361 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></span><br>
362 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></span><br>
363 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></span><br>
364 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></span><br>
365 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodjavascript">FormElement::javascript()</a></span><br>
366 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></span><br>
367 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonChange">FormElement::onChange()</a></span><br>
368 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></span><br>
369 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></span><br>
370 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></span><br>
371 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></span><br>
372 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></span><br>
373 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></span><br>
374 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_form_name">FormElement::set_form_name()</a></span><br>
375 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></span><br>
376 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></span><br>
377 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_stripslashes">FormElement::set_stripslashes()</a></span><br>
378 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></span><br>
379 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></span><br>
380 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></span><br>
381 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></span><br>
382 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></span><br>
383 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></span><br>
384 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></span><br>
385 </blockquote>
386
387 </div>
388 </div>
389
390 <p class="notes" id="credit">
391 Documention generated on Thu, 31 Jul 2003 18:32:33 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
392 </p>
393 </div></body>
394 </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed