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