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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.4 - (show annotations)
Thu May 6 16:24:31 2004 UTC (20 years, 3 months ago) by jonen
Branch: MAIN
CVS Tags: HEAD
Changes since 1.3: +701 -672 lines
File MIME type: text/html 
 updated all to v2.4.1 - Apr 01, 2004
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <!-- template designed by Marco Von Ballmoos -->
6 <title>Docs for page form_utils.inc</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="file-name">/tag_utils/form_utils.inc</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-functions">Functions</a>
21 </div>
22 <div class="info-box-body">
23 <!-- ========== Info from phpDoc block ========= -->
24 <p class="short-description">This file contains various helper functions for building forms and form elements.</p>
25 <p class="description"><p>$Id: _tag_utils_form_utils_inc.html,v 1.39 2004/04/01 17:35:41 hemna Exp $</p></p>
26 <ul class="tags">
27 <li><span class="field">author:</span> Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</li>
28 </ul>
29
30 </div>
31 </div>
32
33
34
35
36
37 <a name="sec-functions"></a>
38 <div class="info-box">
39 <div class="info-box-title">Functions</div>
40 <div class="nav-bar">
41 <a href="#sec-description">Description</a> |
42 <span class="disabled">Functions</span>
43 </div>
44 <div class="info-box-body">
45 <a name="functionform_active_checkbox" id="functionform_active_checkbox"><!-- --></a>
46 <div class="evenrow">
47
48 <div>
49 <span class="method-title">form_active_checkbox</span> (line <span class="line-number">327</span>)
50 </div>
51
52 <!-- ========== Info from phpDoc block ========= -->
53 <p class="short-description">build/render an input tag of type CHECKBOX with onClick javaScript selection</p>
54 <ul class="tags">
55 <li><span class="field">return:</span> a container object</li>
56 <li><span class="field">author:</span> Suren Markossian</li>
57 </ul>
58
59 <div class="method-signature">
60 <span class="method-result">object returns</span>
61 <span class="method-name">
62 form_active_checkbox
63 </span>
64 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$text</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">NULL</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$onClick</span> = <span class="var-default">NULL</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$disabled</span> = <span class="var-default">FALSE</span>])
65 </div>
66
67 <ul class="parameters">
68 <li>
69 <span class="var-type">string</span>
70 <span class="var-name">$name</span><span class="var-description">: - the name of the input tag.</span> </li>
71 <li>
72 <span class="var-type">string</span>
73 <span class="var-name">$value</span><span class="var-description">: - the value of the tag</span> </li>
74 <li>
75 <span class="var-type">string</span>
76 <span class="var-name">$text</span><span class="var-description">: - text label for the checkbox</span> </li>
77 <li>
78 <span class="var-type">string</span>
79 <span class="var-name">$class</span><span class="var-description">: class - CSS class of the text</span> </li>
80 </ul>
81
82
83 </div>
84 <a name="functionform_active_radio" id="functionform_active_radio"><!-- --></a>
85 <div class="oddrow">
86
87 <div>
88 <span class="method-title">form_active_radio</span> (line <span class="line-number">234</span>)
89 </div>
90
91 <!-- ========== Info from phpDoc block ========= -->
92 <p class="short-description">build/render an set of radio buttons with onClick javaScript selection</p>
93 <ul class="tags">
94 <li><span class="field">return:</span> a container object</li>
95 <li><span class="field">author:</span> Suren Markossian</li>
96 </ul>
97
98 <div class="method-signature">
99 <span class="method-result">object returns</span>
100 <span class="method-name">
101 form_active_radio
102 </span>
103 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$list</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$line_break</span> = <span class="var-default">TRUE</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$attribs</span> = <span class="var-default">FALSE</span>])
104 </div>
105
106 <ul class="parameters">
107 <li>
108 <span class="var-type">string</span>
109 <span class="var-name">$name</span><span class="var-description">: - the name of the input tag.</span> </li>
110 <li>
111 <span class="var-type">array</span>
112 <span class="var-name">$list</span><span class="var-description">: - an array of text label = value pairs</span> </li>
113 <li>
114 <span class="var-type">string</span>
115 <span class="var-name">$value</span><span class="var-description">: - the default value (the one that will be checked)</span> </li>
116 <li>
117 <span class="var-type">bool</span>
118 <span class="var-name">$line_break</span><span class="var-description">: - specify whether to put a line break after each radio button</span> </li>
119 <li>
120 <span class="var-type">array</span>
121 <span class="var-name">$attribs</span><span class="var-description">: - specify addionnal attribs for each value</span> </li>
122 </ul>
123
124
125 </div>
126 <a name="functionform_button" id="functionform_button"><!-- --></a>
127 <div class="evenrow">
128
129 <div>
130 <span class="method-title">form_button</span> (line <span class="line-number">143</span>)
131 </div>
132
133 <!-- ========== Info from phpDoc block ========= -->
134 <p class="short-description">build/render an input tag of type button</p>
135 <ul class="tags">
136 <li><span class="field">return:</span> either returns an input object (default) or raw html.</li>
137 </ul>
138
139 <div class="method-signature">
140 <span class="method-result">mixed</span>
141 <span class="method-name">
142 form_button
143 </span>
144 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">array()</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$render_flag</span> = <span class="var-default">FALSE</span>])
145 </div>
146
147 <ul class="parameters">
148 <li>
149 <span class="var-type">string</span>
150 <span class="var-name">$name</span><span class="var-description">: - the name of the input tag.</span> </li>
151 <li>
152 <span class="var-type">string</span>
153 <span class="var-name">$value</span><span class="var-description">: - the value of the tag</span> </li>
154 <li>
155 <span class="var-type">array</span>
156 <span class="var-name">$attributes</span><span class="var-description">: - any extra name='value' pair attributes</span> </li>
157 <li>
158 <span class="var-type">boolean</span>
159 <span class="var-name">$render_flag</span><span class="var-description">: - render an object (FALSE) or raw html (TRUE);</span> </li>
160 </ul>
161
162
163 </div>
164 <a name="functionform_checkbox" id="functionform_checkbox"><!-- --></a>
165 <div class="oddrow">
166
167 <div>
168 <span class="method-title">form_checkbox</span> (line <span class="line-number">304</span>)
169 </div>
170
171 <!-- ========== Info from phpDoc block ========= -->
172 <p class="short-description">build/render an input tag of type CHECKBOX</p>
173 <ul class="tags">
174 <li><span class="field">return:</span> either returns an input object (default) or raw html.</li>
175 </ul>
176
177 <div class="method-signature">
178 <span class="method-result">mixed</span>
179 <span class="method-name">
180 form_checkbox
181 </span>
182 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">array()</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$render_flag</span> = <span class="var-default">FALSE</span>])
183 </div>
184
185 <ul class="parameters">
186 <li>
187 <span class="var-type">string</span>
188 <span class="var-name">$name</span><span class="var-description">: - the name of the input tag.</span> </li>
189 <li>
190 <span class="var-type">string</span>
191 <span class="var-name">$value</span><span class="var-description">: - the value of the tag</span> </li>
192 <li>
193 <span class="var-type">array</span>
194 <span class="var-name">$attributes</span><span class="var-description">: - any extra name='value' pair attributes</span> </li>
195 <li>
196 <span class="var-type">boolean</span>
197 <span class="var-name">$render_flag</span><span class="var-description">: - render an object (FALSE) or raw html (TRUE);</span> </li>
198 </ul>
199
200
201 </div>
202 <a name="functionform_close" id="functionform_close"><!-- --></a>
203 <div class="evenrow">
204
205 <div>
206 <span class="method-title">form_close</span> (line <span class="line-number">60</span>)
207 </div>
208
209 <!-- ========== Info from phpDoc block ========= -->
210 <p class="short-description">render a form close tag</p>
211 <ul class="tags">
212 <li><span class="field">return:</span> - the &lt;/form&gt; tag.</li>
213 </ul>
214
215 <div class="method-signature">
216 <span class="method-result">string</span>
217 <span class="method-name">
218 form_close
219 </span>
220 ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$indent_level</span> = <span class="var-default">0</span>])
221 </div>
222
223
224
225 </div>
226 <a name="functionform_file" id="functionform_file"><!-- --></a>
227 <div class="oddrow">
228
229 <div>
230 <span class="method-title">form_file</span> (line <span class="line-number">386</span>)
231 </div>
232
233 <!-- ========== Info from phpDoc block ========= -->
234 <p class="short-description">build/render an html tag of file</p>
235 <ul class="tags">
236 <li><span class="field">return:</span> either returns an input object (default) or raw html.</li>
237 </ul>
238
239 <div class="method-signature">
240 <span class="method-result">mixed</span>
241 <span class="method-name">
242 form_file
243 </span>
244 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">array()</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$render_flag</span> = <span class="var-default">FALSE</span>])
245 </div>
246
247 <ul class="parameters">
248 <li>
249 <span class="var-type">string</span>
250 <span class="var-name">$name</span><span class="var-description">: - the name of the input tag.</span> </li>
251 <li>
252 <span class="var-type">string</span>
253 <span class="var-name">$value</span><span class="var-description">: - the value of the tag</span> </li>
254 <li>
255 <span class="var-type">array</span>
256 <span class="var-name">$attributes</span><span class="var-description">: - any extra name='value' pair attributes</span> </li>
257 <li>
258 <span class="var-type">boolean</span>
259 <span class="var-name">$render_flag</span><span class="var-description">: - render an object (FALSE) or raw html (TRUE);</span> </li>
260 </ul>
261
262
263 </div>
264 <a name="functionform_hidden" id="functionform_hidden"><!-- --></a>
265 <div class="evenrow">
266
267 <div>
268 <span class="method-title">form_hidden</span> (line <span class="line-number">283</span>)
269 </div>
270
271 <!-- ========== Info from phpDoc block ========= -->
272 <p class="short-description">build/render an input tag of type hidden</p>
273 <ul class="tags">
274 <li><span class="field">return:</span> either returns an input object (default) or raw html.</li>
275 </ul>
276
277 <div class="method-signature">
278 <span class="method-result">mixed</span>
279 <span class="method-name">
280 form_hidden
281 </span>
282 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">array()</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$render_flag</span> = <span class="var-default">FALSE</span>])
283 </div>
284
285 <ul class="parameters">
286 <li>
287 <span class="var-type">string</span>
288 <span class="var-name">$name</span><span class="var-description">: - the name of the input tag.</span> </li>
289 <li>
290 <span class="var-type">string</span>
291 <span class="var-name">$value</span><span class="var-description">: - the value of the tag</span> </li>
292 <li>
293 <span class="var-type">array</span>
294 <span class="var-name">$attributes</span><span class="var-description">: - any extra name='value' pair attributes</span> </li>
295 <li>
296 <span class="var-type">boolean</span>
297 <span class="var-name">$render_flag</span><span class="var-description">: - render an object (FALSE) or raw html (TRUE);</span> </li>
298 </ul>
299
300
301 </div>
302 <a name="functionform_image" id="functionform_image"><!-- --></a>
303 <div class="oddrow">
304
305 <div>
306 <span class="method-title">form_image</span> (line <span class="line-number">187</span>)
307 </div>
308
309 <!-- ========== Info from phpDoc block ========= -->
310 <p class="short-description">build/render an input tag of type image</p>
311 <ul class="tags">
312 <li><span class="field">return:</span> either returns an input object (default) or raw html.</li>
313 </ul>
314
315 <div class="method-signature">
316 <span class="method-result">mixed</span>
317 <span class="method-name">
318 form_image
319 </span>
320 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">NULL</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$src</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">array()</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$render_flag</span> = <span class="var-default">FALSE</span>])
321 </div>
322
323 <ul class="parameters">
324 <li>
325 <span class="var-type">string</span>
326 <span class="var-name">$name</span><span class="var-description">: - the name of the input tag.</span> </li>
327 <li>
328 <span class="var-type">string</span>
329 <span class="var-name">$value</span><span class="var-description">: - the value of the tag</span> </li>
330 <li>
331 <span class="var-type">string</span>
332 <span class="var-name">$src</span><span class="var-description">: - the image src</span> </li>
333 <li>
334 <span class="var-type">array</span>
335 <span class="var-name">$attributes</span><span class="var-description">: - any extra name='value' pair attributes</span> </li>
336 <li>
337 <span class="var-type">boolean</span>
338 <span class="var-name">$render_flag</span><span class="var-description">: - render an object (FALSE) or raw html (TRUE);</span> </li>
339 </ul>
340
341
342 </div>
343 <a name="functionform_open" id="functionform_open"><!-- --></a>
344 <div class="evenrow">
345
346 <div>
347 <span class="method-title">form_open</span> (line <span class="line-number">49</span>)
348 </div>
349
350 <!-- ========== Info from phpDoc block ========= -->
351 <p class="short-description">render an form open tag only.</p>
352 <p class="description"><p>This is usefull for forms that are inside a table. you would render the form tag first, then the table with the form fields.</p></p>
353 <ul class="tags">
354 <li><span class="field">return:</span> returns the raw form tag.</li>
355 </ul>
356
357 <div class="method-signature">
358 <span class="method-result">string</span>
359 <span class="method-name">
360 form_open
361 </span>
362 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$action</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$method</span> = <span class="var-default">"GET"</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">array()</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$indent_level</span> = <span class="var-default">0</span>])
363 </div>
364
365 <ul class="parameters">
366 <li>
367 <span class="var-type">string</span>
368 <span class="var-name">$name</span><span class="var-description">: - name attribute of the form tag.</span> </li>
369 <li>
370 <span class="var-type">string</span>
371 <span class="var-name">$action</span><span class="var-description">: - the form action.</span> </li>
372 <li>
373 <span class="var-type">string</span>
374 <span class="var-name">$method</span><span class="var-description">: - form method</span> </li>
375 <li>
376 <span class="var-type">string</span>
377 <span class="var-name">$attributes</span><span class="var-description">: - any extra name='value' attributes for the form tag.</span> </li>
378 </ul>
379
380
381 </div>
382 <a name="functionform_password" id="functionform_password"><!-- --></a>
383 <div class="oddrow">
384
385 <div>
386 <span class="method-title">form_password</span> (line <span class="line-number">113</span>)
387 </div>
388
389 <!-- ========== Info from phpDoc block ========= -->
390 <p class="short-description">build/render an input tag of type password</p>
391 <ul class="tags">
392 <li><span class="field">return:</span> either returns an input object (default) or raw html.</li>
393 </ul>
394
395 <div class="method-signature">
396 <span class="method-result">mixed</span>
397 <span class="method-name">
398 form_password
399 </span>
400 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">NULL</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$size</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">array</span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">array()</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$render_flag</span> = <span class="var-default">FALSE</span>])
401 </div>
402
403 <ul class="parameters">
404 <li>
405 <span class="var-type">string</span>
406 <span class="var-name">$name</span><span class="var-description">: - the name of the input tag.</span> </li>
407 <li>
408 <span class="var-type">string</span>
409 <span class="var-name">$value</span><span class="var-description">: - the value of the tag</span> </li>
410 <li>
411 <span class="var-type">int</span>
412 <span class="var-name">$size</span><span class="var-description">: - the size in characters of the text tag</span> </li>
413 <li>
414 <span class="var-type">int</span>
415 <span class="var-name">$maxlength</span><span class="var-description">: - the maximum @ of characters for the field</span> </li>
416 <li>
417 <span class="var-type">array</span>
418 <span class="var-name">$attributes</span><span class="var-description">: - any extra name='value' pair attributes</span> </li>
419 <li>
420 <span class="var-type">boolean</span>
421 <span class="var-name">$render_flag</span><span class="var-description">: - render an object (FALSE) or raw html (TRUE);</span> </li>
422 </ul>
423
424
425 </div>
426 <a name="functionform_radio" id="functionform_radio"><!-- --></a>
427 <div class="evenrow">
428
429 <div>
430 <span class="method-title">form_radio</span> (line <span class="line-number">210</span>)
431 </div>
432
433 <!-- ========== Info from phpDoc block ========= -->
434 <p class="short-description">build/render an input tag of type radio</p>
435 <ul class="tags">
436 <li><span class="field">return:</span> either returns an input object (default) or raw html.</li>
437 </ul>
438
439 <div class="method-signature">
440 <span class="method-result">mixed</span>
441 <span class="method-name">
442 form_radio
443 </span>
444 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">array()</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$render_flag</span> = <span class="var-default">FALSE</span>])
445 </div>
446
447 <ul class="parameters">
448 <li>
449 <span class="var-type">string</span>
450 <span class="var-name">$name</span><span class="var-description">: - the name of the input tag.</span> </li>
451 <li>
452 <span class="var-type">string</span>
453 <span class="var-name">$value</span><span class="var-description">: - the value of the tag</span> </li>
454 <li>
455 <span class="var-type">array</span>
456 <span class="var-name">$attributes</span><span class="var-description">: - any extra name='value' pair attributes</span> </li>
457 <li>
458 <span class="var-type">boolean</span>
459 <span class="var-name">$render_flag</span><span class="var-description">: - render an object (FALSE) or raw html (TRUE);</span> </li>
460 </ul>
461
462
463 </div>
464 <a name="functionform_select" id="functionform_select"><!-- --></a>
465 <div class="oddrow">
466
467 <div>
468 <span class="method-title">form_select</span> (line <span class="line-number">457</span>)
469 </div>
470
471 <!-- ========== Info from phpDoc block ========= -->
472 <p class="short-description">Build a select tag with all of its option tags</p>
473 <ul class="tags">
474 <li><span class="field">return:</span> SELECTtag object.</li>
475 <li><span class="field">author:</span> Walt A. Boring IV</li>
476 </ul>
477
478 <div class="method-signature">
479 <span class="method-result">a</span>
480 <span class="method-name">
481 form_select
482 </span>
483 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">array()</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$selected</span> = <span class="var-default">""</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$multiple_flag</span> = <span class="var-default">FALSE</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$attribs</span> = <span class="var-default">false</span>])
484 </div>
485
486 <ul class="parameters">
487 <li>
488 <span class="var-type">string</span>
489 <span class="var-name">$name</span><span class="var-description">: - name of the select.</span> </li>
490 <li>
491 <span class="var-type">array</span>
492 <span class="var-name">$options</span><span class="var-description">: <p>- an array of name value pairs for the options. the format is array( &quot;LABEL&quot; =&gt; VALUE ); each &lt;option value=&quot;VALUE&quot;&gt; LABEL &lt;/option&gt; ie array( &quot;test&quot; =&gt; &quot;foo&quot;) would give an option of &lt;option value=&quot;foo&quot;&gt; test &lt;/option&gt;</p><p>NOTE: this also supports automatic building of the optgroup. Just pass in an array of array(&quot;foogroup&quot; =&gt; array(&quot;name&quot; =&gt; &quot;value1&quot;, &quot;name2&quot; =&gt; &quot;value2&quot;), &quot;bargroup&quot; =&gt; array(&quot;blah&quot; =&gt; &quot;foo&quot;));</p></span> </li>
493 <li>
494 <span class="var-type">mixed</span>
495 <span class="var-name">$selected</span><span class="var-description">: - This can be either a string or an array. If its a string then, it will be the selected option value &lt;option value=&quot;foo&quot; SELECTED&gt;foo&lt;/option&gt; If it is an array, then all of the option values will be marked as SELECTED. This only makes sense to do if the multiple_flag is true.</span> </li>
496 <li>
497 <span class="var-type">boolean</span>
498 <span class="var-name">$multiple_flag</span><span class="var-description">: - is this a multiple selection select box?</span> </li>
499 <li>
500 <span class="var-type">array</span>
501 <span class="var-name">$attribs</span><span class="var-description">: - additionnal attributes to the select tag</span> </li>
502 </ul>
503
504
505 </div>
506 <a name="functionform_select_is_selected" id="functionform_select_is_selected"><!-- --></a>
507 <div class="evenrow">
508
509 <div>
510 <span class="method-title">form_select_is_selected</span> (line <span class="line-number">494</span>)
511 </div>
512
513 <!-- ========== Info from phpDoc block ========= -->
514 <p class="short-description">This function is used by form_select to determin if a value is selected or not.</p>
515
516 <div class="method-signature">
517 <span class="method-result">voolean</span>
518 <span class="method-name">
519 form_select_is_selected
520 </span>
521 (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$selected</span>)
522 </div>
523
524 <ul class="parameters">
525 <li>
526 <span class="var-type">string</span>
527 <span class="var-name">$value</span><span class="var-description">: value</span> </li>
528 <li>
529 <span class="var-type">string</span>
530 <span class="var-name">$selected</span><span class="var-description">: selected value</span> </li>
531 </ul>
532
533
534 </div>
535 <a name="functionform_submit" id="functionform_submit"><!-- --></a>
536 <div class="oddrow">
537
538 <div>
539 <span class="method-title">form_submit</span> (line <span class="line-number">165</span>)
540 </div>
541
542 <!-- ========== Info from phpDoc block ========= -->
543 <p class="short-description">build/render an input tag of type submit</p>
544 <ul class="tags">
545 <li><span class="field">return:</span> either returns an input object (default) or raw html.</li>
546 </ul>
547
548 <div class="method-signature">
549 <span class="method-result">mixed</span>
550 <span class="method-name">
551 form_submit
552 </span>
553 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">array()</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$render_flag</span> = <span class="var-default">FALSE</span>])
554 </div>
555
556 <ul class="parameters">
557 <li>
558 <span class="var-type">string</span>
559 <span class="var-name">$name</span><span class="var-description">: - the name of the input tag.</span> </li>
560 <li>
561 <span class="var-type">string</span>
562 <span class="var-name">$value</span><span class="var-description">: - the value of the tag</span> </li>
563 <li>
564 <span class="var-type">array</span>
565 <span class="var-name">$attributes</span><span class="var-description">: - any extra name='value' pair attributes</span> </li>
566 <li>
567 <span class="var-type">boolean</span>
568 <span class="var-name">$render_flag</span><span class="var-description">: - render an object (FALSE) or raw html (TRUE);</span> </li>
569 </ul>
570
571
572 </div>
573 <a name="functionform_text" id="functionform_text"><!-- --></a>
574 <div class="evenrow">
575
576 <div>
577 <span class="method-title">form_text</span> (line <span class="line-number">80</span>)
578 </div>
579
580 <!-- ========== Info from phpDoc block ========= -->
581 <p class="short-description">build/render an input tag of type text</p>
582 <ul class="tags">
583 <li><span class="field">return:</span> either returns an input object (default) or raw html.</li>
584 </ul>
585
586 <div class="method-signature">
587 <span class="method-result">mixed</span>
588 <span class="method-name">
589 form_text
590 </span>
591 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">NULL</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$size</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">array</span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">array()</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$render_flag</span> = <span class="var-default">FALSE</span>])
592 </div>
593
594 <ul class="parameters">
595 <li>
596 <span class="var-type">string</span>
597 <span class="var-name">$name</span><span class="var-description">: - the name of the input tag.</span> </li>
598 <li>
599 <span class="var-type">string</span>
600 <span class="var-name">$value</span><span class="var-description">: - the value of the tag</span> </li>
601 <li>
602 <span class="var-type">int</span>
603 <span class="var-name">$size</span><span class="var-description">: - the size in characters of the text tag</span> </li>
604 <li>
605 <span class="var-type">int</span>
606 <span class="var-name">$maxlength</span><span class="var-description">: - the maximum @ of characters for the field</span> </li>
607 <li>
608 <span class="var-type">array</span>
609 <span class="var-name">$attributes</span><span class="var-description">: - any extra name='value' pair attributes</span> </li>
610 <li>
611 <span class="var-type">boolean</span>
612 <span class="var-name">$render_flag</span><span class="var-description">: - render an object (FALSE) or raw html (TRUE);</span> </li>
613 </ul>
614
615
616 </div>
617 <a name="functionform_textarea" id="functionform_textarea"><!-- --></a>
618 <div class="oddrow">
619
620 <div>
621 <span class="method-title">form_textarea</span> (line <span class="line-number">413</span>)
622 </div>
623
624 <!-- ========== Info from phpDoc block ========= -->
625 <p class="short-description">build a textarea tag with name and attributes.</p>
626 <ul class="tags">
627 <li><span class="field">return:</span> object.</li>
628 <li><span class="field">author:</span> Walt A. Boring</li>
629 </ul>
630
631 <div class="method-signature">
632 <span class="method-result"><a href="../phpHtmlLib/TEXTAREAtag.html">TEXTAREAtag</a></span>
633 <span class="method-name">
634 form_textarea
635 </span>
636 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">array()</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$render_flag</span> = <span class="var-default">FALSE</span>])
637 </div>
638
639 <ul class="parameters">
640 <li>
641 <span class="var-type">string</span>
642 <span class="var-name">$name</span><span class="var-description">: - the name of the textarea tag.</span> </li>
643 <li>
644 <span class="var-type">string</span>
645 <span class="var-name">$value</span><span class="var-description">: - data to display in the textarea.</span> </li>
646 <li>
647 <span class="var-type">array</span>
648 <span class="var-name">$attributes</span><span class="var-description">: - any extra name='value' pair attributes</span> </li>
649 <li>
650 <span class="var-type">boolean</span>
651 <span class="var-name">$render_flag</span><span class="var-description">: - render an object (FALSE) or raw html (TRUE);</span> </li>
652 </ul>
653
654
655 </div>
656 <a name="functionhtml_form" id="functionhtml_form"><!-- --></a>
657 <div class="evenrow">
658
659 <div>
660 <span class="method-title">html_form</span> (line <span class="line-number">28</span>)
661 </div>
662
663 <!-- ========== Info from phpDoc block ========= -->
664 <p class="short-description">render an form open tag only.</p>
665 <p class="description"><p>This is usefull for forms that are inside a table. you would render the form tag first, then the table with the form fields.</p></p>
666 <ul class="tags">
667 <li><span class="field">return:</span> returns the raw form tag.</li>
668 </ul>
669
670 <div class="method-signature">
671 <span class="method-result">string</span>
672 <span class="method-name">
673 html_form
674 </span>
675 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$action</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$method</span> = <span class="var-default">"GET"</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">array()</span>])
676 </div>
677
678 <ul class="parameters">
679 <li>
680 <span class="var-type">string</span>
681 <span class="var-name">$name</span><span class="var-description">: - name attribute of the form tag.</span> </li>
682 <li>
683 <span class="var-type">string</span>
684 <span class="var-name">$action</span><span class="var-description">: - the form action.</span> </li>
685 <li>
686 <span class="var-type">string</span>
687 <span class="var-name">$method</span><span class="var-description">: - form method</span> </li>
688 <li>
689 <span class="var-type">string</span>
690 <span class="var-name">$attributes</span><span class="var-description">: - any extra name='value' attributes for the form tag.</span> </li>
691 </ul>
692
693
694 </div>
695 </div>
696 </div>
697
698 <p class="notes" id="credit">
699 Documentation generated on Thu, 1 Apr 2004 09:38:56 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a>
700 </p>
701 </div></body>
702 </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed