| 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 |
<h2 class="file-name">Program_Root/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.34 2003/08/01 01:37:37 hemna Exp $</p></p> |
| 25 |
<ul class="tags"> |
| 26 |
<li><span class="field">author:</span> <p>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></p></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> <p>a container object</p></li> |
| 55 |
<li><span class="field">author:</span> <p>Suren Markossian</p></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">: <p>- the name of the input tag.</p></span> </li> |
| 70 |
<li> |
| 71 |
<span class="var-type">string</span> |
| 72 |
<span class="var-name">$value</span><span class="var-description">: <p>- the value of the tag</p></span> </li> |
| 73 |
<li> |
| 74 |
<span class="var-type">string</span> |
| 75 |
<span class="var-name">$text</span><span class="var-description">: <p>- text label for the checkbox</p></span> </li> |
| 76 |
<li> |
| 77 |
<span class="var-type">string</span> |
| 78 |
<span class="var-name">$class</span><span class="var-description">: <p>class - CSS class of the text</p></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> <p>a container object</p></li> |
| 94 |
<li><span class="field">author:</span> <p>Suren Markossian</p></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">: <p>- the name of the input tag.</p></span> </li> |
| 109 |
<li> |
| 110 |
<span class="var-type">array</span> |
| 111 |
<span class="var-name">$list</span><span class="var-description">: <p>- an array of text label = value pairs</p></span> </li> |
| 112 |
<li> |
| 113 |
<span class="var-type">string</span> |
| 114 |
<span class="var-name">$value</span><span class="var-description">: <p>- the default value (the one that will be checked)</p></span> </li> |
| 115 |
<li> |
| 116 |
<span class="var-type">bool</span> |
| 117 |
<span class="var-name">$line_break</span><span class="var-description">: <p>- specify whether to put a line break after each radio button</p></span> </li> |
| 118 |
<li> |
| 119 |
<span class="var-type">array</span> |
| 120 |
<span class="var-name">$attribs</span><span class="var-description">: <p>- specify addionnal attribs for each value</p></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> <p>either returns an input object (default) or raw html.</p></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">: <p>- the name of the input tag.</p></span> </li> |
| 150 |
<li> |
| 151 |
<span class="var-type">string</span> |
| 152 |
<span class="var-name">$value</span><span class="var-description">: <p>- the value of the tag</p></span> </li> |
| 153 |
<li> |
| 154 |
<span class="var-type">array</span> |
| 155 |
<span class="var-name">$attributes</span><span class="var-description">: <p>- any extra name='value' pair attributes</p></span> </li> |
| 156 |
<li> |
| 157 |
<span class="var-type">boolean</span> |
| 158 |
<span class="var-name">$render_flag</span><span class="var-description">: <p>- render an object (FALSE) or raw html (TRUE);</p></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> <p>either returns an input object (default) or raw html.</p></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">: <p>- the name of the input tag.</p></span> </li> |
| 188 |
<li> |
| 189 |
<span class="var-type">string</span> |
| 190 |
<span class="var-name">$value</span><span class="var-description">: <p>- the value of the tag</p></span> </li> |
| 191 |
<li> |
| 192 |
<span class="var-type">array</span> |
| 193 |
<span class="var-name">$attributes</span><span class="var-description">: <p>- any extra name='value' pair attributes</p></span> </li> |
| 194 |
<li> |
| 195 |
<span class="var-type">boolean</span> |
| 196 |
<span class="var-name">$render_flag</span><span class="var-description">: <p>- render an object (FALSE) or raw html (TRUE);</p></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> <p>- the </form> tag.</p></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>) |
| 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> <p>either returns an input object (default) or raw html.</p></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">: <p>- the name of the input tag.</p></span> </li> |
| 250 |
<li> |
| 251 |
<span class="var-type">string</span> |
| 252 |
<span class="var-name">$value</span><span class="var-description">: <p>- the value of the tag</p></span> </li> |
| 253 |
<li> |
| 254 |
<span class="var-type">array</span> |
| 255 |
<span class="var-name">$attributes</span><span class="var-description">: <p>- any extra name='value' pair attributes</p></span> </li> |
| 256 |
<li> |
| 257 |
<span class="var-type">boolean</span> |
| 258 |
<span class="var-name">$render_flag</span><span class="var-description">: <p>- render an object (FALSE) or raw html (TRUE);</p></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> <p>either returns an input object (default) or raw html.</p></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">: <p>- the name of the input tag.</p></span> </li> |
| 288 |
<li> |
| 289 |
<span class="var-type">string</span> |
| 290 |
<span class="var-name">$value</span><span class="var-description">: <p>- the value of the tag</p></span> </li> |
| 291 |
<li> |
| 292 |
<span class="var-type">array</span> |
| 293 |
<span class="var-name">$attributes</span><span class="var-description">: <p>- any extra name='value' pair attributes</p></span> </li> |
| 294 |
<li> |
| 295 |
<span class="var-type">boolean</span> |
| 296 |
<span class="var-name">$render_flag</span><span class="var-description">: <p>- render an object (FALSE) or raw html (TRUE);</p></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> <p>either returns an input object (default) or raw html.</p></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">: <p>- the name of the input tag.</p></span> </li> |
| 326 |
<li> |
| 327 |
<span class="var-type">string</span> |
| 328 |
<span class="var-name">$value</span><span class="var-description">: <p>- the value of the tag</p></span> </li> |
| 329 |
<li> |
| 330 |
<span class="var-type">string</span> |
| 331 |
<span class="var-name">$src</span><span class="var-description">: <p>- the image src</p></span> </li> |
| 332 |
<li> |
| 333 |
<span class="var-type">array</span> |
| 334 |
<span class="var-name">$attributes</span><span class="var-description">: <p>- any extra name='value' pair attributes</p></span> </li> |
| 335 |
<li> |
| 336 |
<span class="var-type">boolean</span> |
| 337 |
<span class="var-name">$render_flag</span><span class="var-description">: <p>- render an object (FALSE) or raw html (TRUE);</p></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> <p>returns the raw form tag.</p></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>) |
| 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">: <p>- name attribute of the form tag.</p></span> </li> |
| 368 |
<li> |
| 369 |
<span class="var-type">string</span> |
| 370 |
<span class="var-name">$action</span><span class="var-description">: <p>- the form action.</p></span> </li> |
| 371 |
<li> |
| 372 |
<span class="var-type">string</span> |
| 373 |
<span class="var-name">$method</span><span class="var-description">: <p>- form method</p></span> </li> |
| 374 |
<li> |
| 375 |
<span class="var-type">string</span> |
| 376 |
<span class="var-name">$attributes</span><span class="var-description">: <p>- any extra name='value' attributes for the form tag.</p></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> <p>either returns an input object (default) or raw html.</p></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">: <p>- the name of the input tag.</p></span> </li> |
| 406 |
<li> |
| 407 |
<span class="var-type">string</span> |
| 408 |
<span class="var-name">$value</span><span class="var-description">: <p>- the value of the tag</p></span> </li> |
| 409 |
<li> |
| 410 |
<span class="var-type">int</span> |
| 411 |
<span class="var-name">$size</span><span class="var-description">: <p>- the size in characters of the text tag</p></span> </li> |
| 412 |
<li> |
| 413 |
<span class="var-type">int</span> |
| 414 |
<span class="var-name">$maxlength</span><span class="var-description">: <p>- the maximum @ of characters for the field</p></span> </li> |
| 415 |
<li> |
| 416 |
<span class="var-type">array</span> |
| 417 |
<span class="var-name">$attributes</span><span class="var-description">: <p>- any extra name='value' pair attributes</p></span> </li> |
| 418 |
<li> |
| 419 |
<span class="var-type">boolean</span> |
| 420 |
<span class="var-name">$render_flag</span><span class="var-description">: <p>- render an object (FALSE) or raw html (TRUE);</p></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> <p>either returns an input object (default) or raw html.</p></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">: <p>- the name of the input tag.</p></span> </li> |
| 450 |
<li> |
| 451 |
<span class="var-type">string</span> |
| 452 |
<span class="var-name">$value</span><span class="var-description">: <p>- the value of the tag</p></span> </li> |
| 453 |
<li> |
| 454 |
<span class="var-type">array</span> |
| 455 |
<span class="var-name">$attributes</span><span class="var-description">: <p>- any extra name='value' pair attributes</p></span> </li> |
| 456 |
<li> |
| 457 |
<span class="var-type">boolean</span> |
| 458 |
<span class="var-name">$render_flag</span><span class="var-description">: <p>- render an object (FALSE) or raw html (TRUE);</p></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">449</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> <p>SELECTtag object.</p></li> |
| 474 |
<li><span class="field">author:</span> <p>Walt A. Boring IV</p></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">: <p>- name of the select.</p></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></span> </li> |
| 492 |
<li> |
| 493 |
<span class="var-type">mixed</span> |
| 494 |
<span class="var-name">$selected</span><span class="var-description">: <p>- 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.</p></span> </li> |
| 495 |
<li> |
| 496 |
<span class="var-type">boolean</span> |
| 497 |
<span class="var-name">$multiple_flag</span><span class="var-description">: <p>- is this a multiple selection select box?</p></span> </li> |
| 498 |
<li> |
| 499 |
<span class="var-type">array</span> |
| 500 |
<span class="var-name">$attribs</span><span class="var-description">: <p>- additionnal attributes to the select tag</p></span> </li> |
| 501 |
</ul> |
| 502 |
|
| 503 |
|
| 504 |
</div> |
| 505 |
<a name="functionform_submit" id="functionform_submit"><!-- --></a> |
| 506 |
<div class="evenrow"> |
| 507 |
|
| 508 |
<div> |
| 509 |
<span class="method-title">form_submit</span> (line <span class="line-number">165</span>) |
| 510 |
</div> |
| 511 |
|
| 512 |
<!-- ========== Info from phpDoc block ========= --> |
| 513 |
<p class="short-description">build/render an input tag of type submit</p> |
| 514 |
<ul class="tags"> |
| 515 |
<li><span class="field">return:</span> <p>either returns an input object (default) or raw html.</p></li> |
| 516 |
</ul> |
| 517 |
|
| 518 |
<div class="method-signature"> |
| 519 |
<span class="method-result">mixed</span> |
| 520 |
<span class="method-name"> |
| 521 |
form_submit |
| 522 |
</span> |
| 523 |
(<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>]) |
| 524 |
</div> |
| 525 |
|
| 526 |
<ul class="parameters"> |
| 527 |
<li> |
| 528 |
<span class="var-type">string</span> |
| 529 |
<span class="var-name">$name</span><span class="var-description">: <p>- the name of the input tag.</p></span> </li> |
| 530 |
<li> |
| 531 |
<span class="var-type">string</span> |
| 532 |
<span class="var-name">$value</span><span class="var-description">: <p>- the value of the tag</p></span> </li> |
| 533 |
<li> |
| 534 |
<span class="var-type">array</span> |
| 535 |
<span class="var-name">$attributes</span><span class="var-description">: <p>- any extra name='value' pair attributes</p></span> </li> |
| 536 |
<li> |
| 537 |
<span class="var-type">boolean</span> |
| 538 |
<span class="var-name">$render_flag</span><span class="var-description">: <p>- render an object (FALSE) or raw html (TRUE);</p></span> </li> |
| 539 |
</ul> |
| 540 |
|
| 541 |
|
| 542 |
</div> |
| 543 |
<a name="functionform_text" id="functionform_text"><!-- --></a> |
| 544 |
<div class="oddrow"> |
| 545 |
|
| 546 |
<div> |
| 547 |
<span class="method-title">form_text</span> (line <span class="line-number">80</span>) |
| 548 |
</div> |
| 549 |
|
| 550 |
<!-- ========== Info from phpDoc block ========= --> |
| 551 |
<p class="short-description">build/render an input tag of type text</p> |
| 552 |
<ul class="tags"> |
| 553 |
<li><span class="field">return:</span> <p>either returns an input object (default) or raw html.</p></li> |
| 554 |
</ul> |
| 555 |
|
| 556 |
<div class="method-signature"> |
| 557 |
<span class="method-result">mixed</span> |
| 558 |
<span class="method-name"> |
| 559 |
form_text |
| 560 |
</span> |
| 561 |
(<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>]) |
| 562 |
</div> |
| 563 |
|
| 564 |
<ul class="parameters"> |
| 565 |
<li> |
| 566 |
<span class="var-type">string</span> |
| 567 |
<span class="var-name">$name</span><span class="var-description">: <p>- the name of the input tag.</p></span> </li> |
| 568 |
<li> |
| 569 |
<span class="var-type">string</span> |
| 570 |
<span class="var-name">$value</span><span class="var-description">: <p>- the value of the tag</p></span> </li> |
| 571 |
<li> |
| 572 |
<span class="var-type">int</span> |
| 573 |
<span class="var-name">$size</span><span class="var-description">: <p>- the size in characters of the text tag</p></span> </li> |
| 574 |
<li> |
| 575 |
<span class="var-type">int</span> |
| 576 |
<span class="var-name">$maxlength</span><span class="var-description">: <p>- the maximum @ of characters for the field</p></span> </li> |
| 577 |
<li> |
| 578 |
<span class="var-type">array</span> |
| 579 |
<span class="var-name">$attributes</span><span class="var-description">: <p>- any extra name='value' pair attributes</p></span> </li> |
| 580 |
<li> |
| 581 |
<span class="var-type">boolean</span> |
| 582 |
<span class="var-name">$render_flag</span><span class="var-description">: <p>- render an object (FALSE) or raw html (TRUE);</p></span> </li> |
| 583 |
</ul> |
| 584 |
|
| 585 |
|
| 586 |
</div> |
| 587 |
<a name="functionform_textarea" id="functionform_textarea"><!-- --></a> |
| 588 |
<div class="evenrow"> |
| 589 |
|
| 590 |
<div> |
| 591 |
<span class="method-title">form_textarea</span> (line <span class="line-number">413</span>) |
| 592 |
</div> |
| 593 |
|
| 594 |
<!-- ========== Info from phpDoc block ========= --> |
| 595 |
<p class="short-description">build a textarea tag with name and attributes.</p> |
| 596 |
<ul class="tags"> |
| 597 |
<li><span class="field">return:</span> <p>object.</p></li> |
| 598 |
<li><span class="field">author:</span> <p>Walt A. Boring</p></li> |
| 599 |
</ul> |
| 600 |
|
| 601 |
<div class="method-signature"> |
| 602 |
<span class="method-result"><a href="../phpHtmlLib/TEXTAREAtag.html">TEXTAREAtag</a></span> |
| 603 |
<span class="method-name"> |
| 604 |
form_textarea |
| 605 |
</span> |
| 606 |
(<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>]) |
| 607 |
</div> |
| 608 |
|
| 609 |
<ul class="parameters"> |
| 610 |
<li> |
| 611 |
<span class="var-type">string</span> |
| 612 |
<span class="var-name">$name</span><span class="var-description">: <p>- the name of the textarea tag.</p></span> </li> |
| 613 |
<li> |
| 614 |
<span class="var-type">string</span> |
| 615 |
<span class="var-name">$value</span><span class="var-description">: <p>- data to display in the textarea.</p></span> </li> |
| 616 |
<li> |
| 617 |
<span class="var-type">array</span> |
| 618 |
<span class="var-name">$attributes</span><span class="var-description">: <p>- any extra name='value' pair attributes</p></span> </li> |
| 619 |
<li> |
| 620 |
<span class="var-type">boolean</span> |
| 621 |
<span class="var-name">$render_flag</span><span class="var-description">: <p>- render an object (FALSE) or raw html (TRUE);</p></span> </li> |
| 622 |
</ul> |
| 623 |
|
| 624 |
|
| 625 |
</div> |
| 626 |
<a name="functionhtml_form" id="functionhtml_form"><!-- --></a> |
| 627 |
<div class="oddrow"> |
| 628 |
|
| 629 |
<div> |
| 630 |
<span class="method-title">html_form</span> (line <span class="line-number">28</span>) |
| 631 |
</div> |
| 632 |
|
| 633 |
<!-- ========== Info from phpDoc block ========= --> |
| 634 |
<p class="short-description">render an form open tag only.</p> |
| 635 |
<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> |
| 636 |
<ul class="tags"> |
| 637 |
<li><span class="field">return:</span> <p>returns the raw form tag.</p></li> |
| 638 |
</ul> |
| 639 |
|
| 640 |
<div class="method-signature"> |
| 641 |
<span class="method-result">string</span> |
| 642 |
<span class="method-name"> |
| 643 |
html_form |
| 644 |
</span> |
| 645 |
(<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>]) |
| 646 |
</div> |
| 647 |
|
| 648 |
<ul class="parameters"> |
| 649 |
<li> |
| 650 |
<span class="var-type">string</span> |
| 651 |
<span class="var-name">$name</span><span class="var-description">: <p>- name attribute of the form tag.</p></span> </li> |
| 652 |
<li> |
| 653 |
<span class="var-type">string</span> |
| 654 |
<span class="var-name">$action</span><span class="var-description">: <p>- the form action.</p></span> </li> |
| 655 |
<li> |
| 656 |
<span class="var-type">string</span> |
| 657 |
<span class="var-name">$method</span><span class="var-description">: <p>- form method</p></span> </li> |
| 658 |
<li> |
| 659 |
<span class="var-type">string</span> |
| 660 |
<span class="var-name">$attributes</span><span class="var-description">: <p>- any extra name='value' attributes for the form tag.</p></span> </li> |
| 661 |
</ul> |
| 662 |
|
| 663 |
|
| 664 |
</div> |
| 665 |
</div> |
| 666 |
</div> |
| 667 |
|
| 668 |
<p class="notes" id="credit"> |
| 669 |
Documention generated on Thu, 31 Jul 2003 18:32:47 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a> |
| 670 |
</p> |
| 671 |
</div></body> |
| 672 |
</html> |
Parent Directory
| 
Revision Log
