| 1 |
<?xml version="1.0" encoding="iso-8859-1"?> |
| 2 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 3 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
| 4 |
<head> |
| 5 |
<!-- template designed by Marco Von Ballmoos --> |
| 6 |
<title>Docs For Class StandardFormContent</title> |
| 7 |
<link rel="stylesheet" href="../../media/stylesheet.css" /> |
| 8 |
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> |
| 9 |
</head> |
| 10 |
<body> |
| 11 |
<div class="page-body"> |
| 12 |
<h2 class="class-name">Class StandardFormContent</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-descendents">Descendents</a> |
| 20 |
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 21 |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 22 |
|
| 23 |
</div> |
| 24 |
<div class="info-box-body"> |
| 25 |
<!-- ========== Info from phpDoc block ========= --> |
| 26 |
<p class="short-description">This is a child of the FormContent class to provide a 'standard' look and feel for forms.</p> |
| 27 |
<p class="description"><p>It also enables a confirmation 'page' by default.</p></p> |
| 28 |
<p class="notes"> |
| 29 |
Located in <a class="field" href="_form_StandardFormContent_inc.html">Program_Root/form/StandardFormContent.inc</a> (line <span class="field">26</span>) |
| 30 |
</p> |
| 31 |
|
| 32 |
|
| 33 |
<pre><a href="../../phpHtmlLib/FormProcessing/FormContent.html">FormContent</a> |
| 34 |
| |
| 35 |
--StandardFormContent</pre> |
| 36 |
|
| 37 |
</div> |
| 38 |
</div> |
| 39 |
|
| 40 |
<a name="sec-descendents"></a> |
| 41 |
<div class="info-box"> |
| 42 |
<div class="info-box-title">Direct descendents</div> |
| 43 |
<div class="nav-bar"> |
| 44 |
<a href="#sec-description">Description</a> | |
| 45 |
<span class="disabled">Descendents</span> |
| 46 |
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 47 |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 48 |
|
| 49 |
</div> |
| 50 |
<div class="info-box-body"> |
| 51 |
<table cellpadding="2" cellspacing="0" class="class-table"> |
| 52 |
<tr> |
| 53 |
<th class="class-table-header">Class</th> |
| 54 |
<th class="class-table-header">Description</th> |
| 55 |
</tr> |
| 56 |
<tr> |
| 57 |
<td style="padding-right: 2em"><a href="../../phpHtmlLib/form-examples/Step1.html">Step1</a></td> |
| 58 |
<td> |
| 59 |
A simple Page Layout object child. |
| 60 |
</td> |
| 61 |
</tr> |
| 62 |
<tr> |
| 63 |
<td style="padding-right: 2em"><a href="../../phpHtmlLib/form-examples/Step2.html">Step2</a></td> |
| 64 |
<td> |
| 65 |
This is a child of the FormContent class to provide a 'standard' look and feel for forms. |
| 66 |
</td> |
| 67 |
</tr> |
| 68 |
<tr> |
| 69 |
<td style="padding-right: 2em"><a href="../../phpHtmlLib/form-examples/Step3.html">Step3</a></td> |
| 70 |
<td> |
| 71 |
This is a child of the FormContent class to provide a 'standard' look and feel for forms. |
| 72 |
</td> |
| 73 |
</tr> |
| 74 |
<tr> |
| 75 |
<td style="padding-right: 2em"><a href="../../phpHtmlLib/form-examples/StandardAccountForm.html">StandardAccountForm</a></td> |
| 76 |
<td> |
| 77 |
A simple Page Layout object child. |
| 78 |
</td> |
| 79 |
</tr> |
| 80 |
</table> |
| 81 |
</div> |
| 82 |
</div> |
| 83 |
|
| 84 |
<a name="sec-var-summary"></a> |
| 85 |
<div class="info-box"> |
| 86 |
<div class="info-box-title">Variable Summary</span></div> |
| 87 |
<div class="nav-bar"> |
| 88 |
<a href="#sec-description">Description</a> | |
| 89 |
<a href="#sec-descendents">Descendents</a> | |
| 90 |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
| 91 |
| |
| 92 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 93 |
|
| 94 |
</div> |
| 95 |
<div class="info-box-body"> |
| 96 |
<div class="var-summary"> |
| 97 |
<div class="var-title"> |
| 98 |
<span class="var-type">mixed</span> |
| 99 |
<a href="#$_form_title" title="details" class="var-name">$_form_title</a> |
| 100 |
</div> |
| 101 |
<div class="var-title"> |
| 102 |
<span class="var-type">mixed</span> |
| 103 |
<a href="#$_infotable" title="details" class="var-name">$_infotable</a> |
| 104 |
</div> |
| 105 |
</div> |
| 106 |
</div> |
| 107 |
</div> |
| 108 |
|
| 109 |
<a name="sec-method-summary"></a> |
| 110 |
<div class="info-box"> |
| 111 |
<div class="info-box-title">Method Summary</span></div> |
| 112 |
<div class="nav-bar"> |
| 113 |
<a href="#sec-description">Description</a> | |
| 114 |
<a href="#sec-descendents">Descendents</a> | |
| 115 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 116 |
|
| 117 |
| |
| 118 |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
| 119 |
</div> |
| 120 |
<div class="info-box-body"> |
| 121 |
<div class="method-summary"> |
| 122 |
|
| 123 |
<div class="method-definition"> |
| 124 |
<span class="method-result">void</span> |
| 125 |
<a href="#StandardFormContent" title="details" class="method-name">StandardFormContent</a> |
| 126 |
(<span class="var-type">mixed</span> <span class="var-name">$title</span>, [<span class="var-type">mixed</span> <span class="var-name">$cancel_action</span> = <span class="var-default">NULL</span>], [<span class="var-type">mixed</span> <span class="var-name">$width</span> = <span class="var-default">"100%"</span>]) |
| 127 |
</div> |
| 128 |
|
| 129 |
<div class="method-definition"> |
| 130 |
<span class="method-result">void</span> |
| 131 |
<a href="#add_form_block" title="details" class="method-name">add_form_block</a> |
| 132 |
([<span class="var-type">string</span> <span class="var-name">$title</span> = <span class="var-default">NULL</span>], <span class="var-type"><a href="../../phpHtmlLib/TABLEtag.html">TABLEtag</a></span> <span class="var-name">&$table</span>) |
| 133 |
</div> |
| 134 |
|
| 135 |
<div class="method-definition"> |
| 136 |
<span class="method-result"><a href="../../phpHtmlLib/FIELDSETtag.html">FIELDSETtag</a></span> |
| 137 |
<a href="#build_form_block" title="details" class="method-name">&build_form_block</a> |
| 138 |
([<span class="var-type">string</span> <span class="var-name">$title</span> = <span class="var-default">NULL</span>], <span class="var-type"><a href="../../phpHtmlLib/TABLEtag.html">TABLEtag</a></span> <span class="var-name">&$content</span>) |
| 139 |
</div> |
| 140 |
|
| 141 |
<div class="method-definition"> |
| 142 |
<span class="method-result">void</span> |
| 143 |
<a href="#confirm_action" title="details" class="method-name">confirm_action</a> |
| 144 |
() |
| 145 |
</div> |
| 146 |
|
| 147 |
<div class="method-definition"> |
| 148 |
<span class="method-result"><a href="../../phpHtmlLib/InfoTable.html">InfoTable</a></span> |
| 149 |
<a href="#form" title="details" class="method-name">form</a> |
| 150 |
(<span class="var-type">array</span> <span class="var-name">0</span>, <span class="var-type">array</span> <span class="var-name">1</span>) |
| 151 |
</div> |
| 152 |
|
| 153 |
<div class="method-definition"> |
| 154 |
<span class="method-result">boolean</span> |
| 155 |
<a href="#form_action" title="details" class="method-name">form_action</a> |
| 156 |
() |
| 157 |
</div> |
| 158 |
|
| 159 |
<div class="method-definition"> |
| 160 |
<span class="method-result">mixed</span> |
| 161 |
<a href="#form_confirm" title="details" class="method-name">form_confirm</a> |
| 162 |
([<span class="var-type">string</span> <span class="var-name">$title</span> = <span class="var-default">"Form Confirmation"</span>], [<span class="var-type">boolean</span> <span class="var-name">$show_buttons</span> = <span class="var-default">TRUE</span>]) |
| 163 |
</div> |
| 164 |
|
| 165 |
<div class="method-definition"> |
| 166 |
<span class="method-result">object</span> |
| 167 |
<a href="#form_content" title="details" class="method-name">form_content</a> |
| 168 |
() |
| 169 |
</div> |
| 170 |
|
| 171 |
<div class="method-definition"> |
| 172 |
<span class="method-result">ButtonPanel</span> |
| 173 |
<a href="#form_content_buttons" title="details" class="method-name">form_content_buttons</a> |
| 174 |
() |
| 175 |
</div> |
| 176 |
|
| 177 |
<div class="method-definition"> |
| 178 |
<span class="method-result">void</span> |
| 179 |
<a href="#set_form_title" title="details" class="method-name">set_form_title</a> |
| 180 |
(<span class="var-type">string</span> <span class="var-name">$title</span>) |
| 181 |
</div> |
| 182 |
|
| 183 |
<div class="method-definition"> |
| 184 |
<span class="method-result">void</span> |
| 185 |
<a href="#_div_wrapper" title="details" class="method-name">&_div_wrapper</a> |
| 186 |
() |
| 187 |
</div> |
| 188 |
|
| 189 |
<div class="method-definition"> |
| 190 |
<span class="method-result">void</span> |
| 191 |
<a href="#_form_content_table" title="details" class="method-name">_form_content_table</a> |
| 192 |
([<span class="var-type">mixed</span> <span class="var-name">$width</span> = <span class="var-default">"100%"</span>], <span class="var-type">mixed</span> <span class="var-name">$border</span>, <span class="var-type">mixed</span> <span class="var-name">$cellspacing</span>, [<span class="var-type">mixed</span> <span class="var-name">$cellpadding</span> = <span class="var-default">3</span>]) |
| 193 |
</div> |
| 194 |
</div> |
| 195 |
</div> |
| 196 |
</div> |
| 197 |
|
| 198 |
<a name="sec-vars"></a> |
| 199 |
<div class="info-box"> |
| 200 |
<div class="info-box-title">Variables</div> |
| 201 |
<div class="nav-bar"> |
| 202 |
<a href="#sec-description">Description</a> | |
| 203 |
<a href="#sec-descendents">Descendents</a> | |
| 204 |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
| 205 |
|
| 206 |
|
| 207 |
| |
| 208 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 209 |
|
| 210 |
</div> |
| 211 |
<div class="info-box-body"> |
| 212 |
<a name="var$_form_title" id="$_form_title"><!-- --></A> |
| 213 |
<div class="evenrow"> |
| 214 |
|
| 215 |
<div class="var-header"> |
| 216 |
<span class="var-title"> |
| 217 |
<span class="var-type">mixed</span> |
| 218 |
<span class="var-name">$_form_title</span> |
| 219 |
= <span class="var-default"> ""</span> (line <span class="line-number">33</span>) |
| 220 |
</span> |
| 221 |
</div> |
| 222 |
|
| 223 |
<!-- ========== Info from phpDoc block ========= --> |
| 224 |
<p class="short-description">The title used in the wrapping table</p> |
| 225 |
|
| 226 |
|
| 227 |
|
| 228 |
|
| 229 |
|
| 230 |
</div> |
| 231 |
<a name="var$_infotable" id="$_infotable"><!-- --></A> |
| 232 |
<div class="oddrow"> |
| 233 |
|
| 234 |
<div class="var-header"> |
| 235 |
<span class="var-title"> |
| 236 |
<span class="var-type">mixed</span> |
| 237 |
<span class="var-name">$_infotable</span> |
| 238 |
= <span class="var-default"> NULL</span> (line <span class="line-number">39</span>) |
| 239 |
</span> |
| 240 |
</div> |
| 241 |
|
| 242 |
<!-- ========== Info from phpDoc block ========= --> |
| 243 |
<p class="short-description">the InfoTable wrapper that holds all fields.</p> |
| 244 |
|
| 245 |
|
| 246 |
|
| 247 |
|
| 248 |
|
| 249 |
</div> |
| 250 |
<h4>Inherited Variables</h4> |
| 251 |
<A NAME='inherited_vars'><!-- --></A> |
| 252 |
<p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormContent.html">FormContent</a></span></p> |
| 253 |
<blockquote> |
| 254 |
<span class="var-title"> |
| 255 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_action_counter">FormContent::$_action_counter</a></span><br> |
| 256 |
</span> |
| 257 |
<span class="var-title"> |
| 258 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_action_message">FormContent::$_action_message</a></span><br> |
| 259 |
</span> |
| 260 |
<span class="var-title"> |
| 261 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_cancel_action">FormContent::$_cancel_action</a></span><br> |
| 262 |
</span> |
| 263 |
<span class="var-title"> |
| 264 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_default_label_css">FormContent::$_default_label_css</a></span><br> |
| 265 |
</span> |
| 266 |
<span class="var-title"> |
| 267 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_elements">FormContent::$_elements</a></span><br> |
| 268 |
</span> |
| 269 |
<span class="var-title"> |
| 270 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_error_label_css">FormContent::$_error_label_css</a></span><br> |
| 271 |
</span> |
| 272 |
<span class="var-title"> |
| 273 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_form_errors_title">FormContent::$_form_errors_title</a></span><br> |
| 274 |
</span> |
| 275 |
<span class="var-title"> |
| 276 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_form_errors_width">FormContent::$_form_errors_width</a></span><br> |
| 277 |
</span> |
| 278 |
<span class="var-title"> |
| 279 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_form_name">FormContent::$_form_name</a></span><br> |
| 280 |
</span> |
| 281 |
<span class="var-title"> |
| 282 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_has_confirm">FormContent::$_has_confirm</a></span><br> |
| 283 |
</span> |
| 284 |
<span class="var-title"> |
| 285 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_hidden_elements">FormContent::$_hidden_elements</a></span><br> |
| 286 |
</span> |
| 287 |
<span class="var-title"> |
| 288 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_required_field_marker">FormContent::$_required_field_marker</a></span><br> |
| 289 |
</span> |
| 290 |
<span class="var-title"> |
| 291 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_required_field_text">FormContent::$_required_field_text</a></span><br> |
| 292 |
</span> |
| 293 |
<span class="var-title"> |
| 294 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_stripslashes">FormContent::$_stripslashes</a></span><br> |
| 295 |
</span> |
| 296 |
<span class="var-title"> |
| 297 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#var$_width">FormContent::$_width</a></span><br> |
| 298 |
</span> |
| 299 |
</blockquote> |
| 300 |
|
| 301 |
</div> |
| 302 |
</div> |
| 303 |
|
| 304 |
<a name="sec-methods"></a> |
| 305 |
<div class="info-box"> |
| 306 |
<div class="info-box-title">Methods</div> |
| 307 |
<div class="nav-bar"> |
| 308 |
<a href="#sec-description">Description</a> | |
| 309 |
<a href="#sec-descendents">Descendents</a> | |
| 310 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 311 |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
| 312 |
|
| 313 |
</div> |
| 314 |
<div class="info-box-body"> |
| 315 |
<A NAME='method_detail'></A> |
| 316 |
<a name="methodStandardFormContent" id="StandardFormContent"><!-- --></a> |
| 317 |
<div class="evenrow"> |
| 318 |
|
| 319 |
<div class="method-header"> |
| 320 |
<span class="method-title">Constructor StandardFormContent</span> (line <span class="line-number">42</span>) |
| 321 |
</div> |
| 322 |
|
| 323 |
<!-- ========== Info from phpDoc block ========= --> |
| 324 |
|
| 325 |
<div class="method-signature"> |
| 326 |
<span class="method-result">void</span> |
| 327 |
<span class="method-name"> |
| 328 |
StandardFormContent |
| 329 |
</span> |
| 330 |
(<span class="var-type">mixed</span> <span class="var-name">$title</span>, [<span class="var-type">mixed</span> <span class="var-name">$cancel_action</span> = <span class="var-default">NULL</span>], [<span class="var-type">mixed</span> <span class="var-name">$width</span> = <span class="var-default">"100%"</span>]) |
| 331 |
</div> |
| 332 |
|
| 333 |
|
| 334 |
|
| 335 |
</div> |
| 336 |
<a name="methodadd_form_block" id="add_form_block"><!-- --></a> |
| 337 |
<div class="oddrow"> |
| 338 |
|
| 339 |
<div class="method-header"> |
| 340 |
<span class="method-title">add_form_block</span> (line <span class="line-number">193</span>) |
| 341 |
</div> |
| 342 |
|
| 343 |
<!-- ========== Info from phpDoc block ========= --> |
| 344 |
<p class="short-description">This function is used to add a block of form fields inside a table to this form.</p> |
| 345 |
<p class="description"><p>This table will automatically get wrapped inside a fieldset with a legend tag to label the block</p></p> |
| 346 |
|
| 347 |
<div class="method-signature"> |
| 348 |
<span class="method-result">void</span> |
| 349 |
<span class="method-name"> |
| 350 |
add_form_block |
| 351 |
</span> |
| 352 |
([<span class="var-type">string</span> <span class="var-name">$title</span> = <span class="var-default">NULL</span>], <span class="var-type"><a href="../../phpHtmlLib/TABLEtag.html">TABLEtag</a></span> <span class="var-name">&$table</span>) |
| 353 |
</div> |
| 354 |
|
| 355 |
<ul class="parameters"> |
| 356 |
<li> |
| 357 |
<span class="var-type">string</span> |
| 358 |
<span class="var-name">$title</span><span class="var-description">: <p>- the title for the fieldset</p></span> </li> |
| 359 |
<li> |
| 360 |
<span class="var-type"><a href="../../phpHtmlLib/TABLEtag.html">TABLEtag</a></span> |
| 361 |
<span class="var-name">&$table</span><span class="var-description">: <p>- the form fields inside a table</p></span> </li> |
| 362 |
</ul> |
| 363 |
|
| 364 |
|
| 365 |
</div> |
| 366 |
<a name="methodbuild_form_block" id="build_form_block"><!-- --></a> |
| 367 |
<div class="evenrow"> |
| 368 |
|
| 369 |
<div class="method-header"> |
| 370 |
<span class="method-title">build_form_block</span> (line <span class="line-number">206</span>) |
| 371 |
</div> |
| 372 |
|
| 373 |
<!-- ========== Info from phpDoc block ========= --> |
| 374 |
<p class="short-description">this builds a fieldset and legend and adds the form table to it.</p> |
| 375 |
|
| 376 |
<div class="method-signature"> |
| 377 |
<span class="method-result"><a href="../../phpHtmlLib/FIELDSETtag.html">FIELDSETtag</a></span> |
| 378 |
<span class="method-name"> |
| 379 |
&build_form_block |
| 380 |
</span> |
| 381 |
([<span class="var-type">string</span> <span class="var-name">$title</span> = <span class="var-default">NULL</span>], <span class="var-type"><a href="../../phpHtmlLib/TABLEtag.html">TABLEtag</a></span> <span class="var-name">&$content</span>) |
| 382 |
</div> |
| 383 |
|
| 384 |
<ul class="parameters"> |
| 385 |
<li> |
| 386 |
<span class="var-type">string</span> |
| 387 |
<span class="var-name">$title</span><span class="var-description">: <p>- the legend string</p></span> </li> |
| 388 |
<li> |
| 389 |
<span class="var-type"><a href="../../phpHtmlLib/TABLEtag.html">TABLEtag</a></span> |
| 390 |
<span class="var-name">&$content</span><span class="var-description">: <p>- the form fields in a table</p></span> </li> |
| 391 |
</ul> |
| 392 |
|
| 393 |
|
| 394 |
</div> |
| 395 |
<a name="methodconfirm_action" id="confirm_action"><!-- --></a> |
| 396 |
<div class="oddrow"> |
| 397 |
|
| 398 |
<div class="method-header"> |
| 399 |
<span class="method-title">confirm_action</span> (line <span class="line-number">160</span>) |
| 400 |
</div> |
| 401 |
|
| 402 |
<!-- ========== Info from phpDoc block ========= --> |
| 403 |
<p class="short-description">This method is responsible for handling the confirmation page's Confirm action.</p> |
| 404 |
|
| 405 |
<div class="method-signature"> |
| 406 |
<span class="method-result">void</span> |
| 407 |
<span class="method-name"> |
| 408 |
confirm_action |
| 409 |
</span> |
| 410 |
() |
| 411 |
</div> |
| 412 |
|
| 413 |
|
| 414 |
|
| 415 |
<hr class="separator" /> |
| 416 |
<div class="notes">Redefined in descendants as:</div> |
| 417 |
<ul class="redefinitions"> |
| 418 |
<li> |
| 419 |
<a href="../../phpHtmlLib/form-examples/Step1.html#methodconfirm_action">Step1::confirm_action()</a> |
| 420 |
: This method will get called after all validation has passed, and the confirmation has been accepted. |
| 421 |
</li> |
| 422 |
<li> |
| 423 |
<a href="../../phpHtmlLib/form-examples/Step2.html#methodconfirm_action">Step2::confirm_action()</a> |
| 424 |
: This method will get called after all validation has passed, and the confirmation has been accepted. |
| 425 |
</li> |
| 426 |
<li> |
| 427 |
<a href="../../phpHtmlLib/form-examples/Step3.html#methodconfirm_action">Step3::confirm_action()</a> |
| 428 |
: This method will get called after all validation has passed, and the confirmation has been accepted. |
| 429 |
</li> |
| 430 |
<li> |
| 431 |
<a href="../../phpHtmlLib/form-examples/StandardAccountForm.html#methodconfirm_action">StandardAccountForm::confirm_action()</a> |
| 432 |
: This method will get called after all validation has passed, and the confirmation has been accepted. |
| 433 |
</li> |
| 434 |
</ul> |
| 435 |
</div> |
| 436 |
<a name="methodform" id="form"><!-- --></a> |
| 437 |
<div class="evenrow"> |
| 438 |
|
| 439 |
<div class="method-header"> |
| 440 |
<span class="method-title">form</span> (line <span class="line-number">68</span>) |
| 441 |
</div> |
| 442 |
|
| 443 |
<!-- ========== Info from phpDoc block ========= --> |
| 444 |
<p class="short-description">this builds the main wrapper for the form fields and ads the Save and Cancel buttons</p> |
| 445 |
<ul class="tags"> |
| 446 |
<li><span class="field">return:</span> <p>widget object</p></li> |
| 447 |
</ul> |
| 448 |
|
| 449 |
<div class="method-signature"> |
| 450 |
<span class="method-result"><a href="../../phpHtmlLib/InfoTable.html">InfoTable</a></span> |
| 451 |
<span class="method-name"> |
| 452 |
form |
| 453 |
</span> |
| 454 |
(<span class="var-type">array</span> <span class="var-name">0</span>, <span class="var-type">array</span> <span class="var-name">1</span>) |
| 455 |
</div> |
| 456 |
|
| 457 |
<ul class="parameters"> |
| 458 |
<li> |
| 459 |
<span class="var-type">array</span> |
| 460 |
<span class="var-name">0</span><span class="var-description">: <p>- the form data</p></span> </li> |
| 461 |
<li> |
| 462 |
<span class="var-type">array</span> |
| 463 |
<span class="var-name">1</span><span class="var-description">: <p>- the form error fields (if any)</p></span> </li> |
| 464 |
</ul> |
| 465 |
|
| 466 |
<hr class="separator" /> |
| 467 |
<div class="notes">Redefinition of:</div> |
| 468 |
<dl> |
| 469 |
<dt><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform">FormContent::form()</a></dt> |
| 470 |
<dd>This method builds the html form.</dd> |
| 471 |
</dl> |
| 472 |
|
| 473 |
</div> |
| 474 |
<a name="methodform_action" id="form_action"><!-- --></a> |
| 475 |
<div class="oddrow"> |
| 476 |
|
| 477 |
<div class="method-header"> |
| 478 |
<span class="method-title">form_action</span> (line <span class="line-number">144</span>) |
| 479 |
</div> |
| 480 |
|
| 481 |
<!-- ========== Info from phpDoc block ========= --> |
| 482 |
<p class="short-description">This method handles the form action.</p> |
| 483 |
<ul class="tags"> |
| 484 |
<li><span class="field">return:</span> <p>TRUE = success FALSE = failed.</p></li> |
| 485 |
</ul> |
| 486 |
|
| 487 |
<div class="method-signature"> |
| 488 |
<span class="method-result">boolean</span> |
| 489 |
<span class="method-name"> |
| 490 |
form_action |
| 491 |
</span> |
| 492 |
() |
| 493 |
</div> |
| 494 |
|
| 495 |
|
| 496 |
<hr class="separator" /> |
| 497 |
<div class="notes">Redefinition of:</div> |
| 498 |
<dl> |
| 499 |
<dt><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform_action">FormContent::form_action()</a></dt> |
| 500 |
<dd>This method handles the</dd> |
| 501 |
</dl> |
| 502 |
|
| 503 |
</div> |
| 504 |
<a name="methodform_confirm" id="form_confirm"><!-- --></a> |
| 505 |
<div class="evenrow"> |
| 506 |
|
| 507 |
<div class="method-header"> |
| 508 |
<span class="method-title">form_confirm</span> (line <span class="line-number">111</span>) |
| 509 |
</div> |
| 510 |
|
| 511 |
<!-- ========== Info from phpDoc block ========= --> |
| 512 |
<p class="short-description">This function is used to show an intermediary confirmation page. Use this function to show a confirmation of the data that was submitted by the user.</p> |
| 513 |
<p class="description"><p>This will get called after all of the form data was successfully validated. All of the form data will automatically be created as hidden form fields. All you have to do is show the data, and a confirm submit button.</p></p> |
| 514 |
<ul class="tags"> |
| 515 |
<li><span class="field">return:</span> <p>- either raw html, or some container HTMLTag object.</p></li> |
| 516 |
</ul> |
| 517 |
|
| 518 |
<div class="method-signature"> |
| 519 |
<span class="method-result">mixed</span> |
| 520 |
<span class="method-name"> |
| 521 |
form_confirm |
| 522 |
</span> |
| 523 |
([<span class="var-type">string</span> <span class="var-name">$title</span> = <span class="var-default">"Form Confirmation"</span>], [<span class="var-type">boolean</span> <span class="var-name">$show_buttons</span> = <span class="var-default">TRUE</span>]) |
| 524 |
</div> |
| 525 |
|
| 526 |
<ul class="parameters"> |
| 527 |
<li> |
| 528 |
<span class="var-type">string</span> |
| 529 |
<span class="var-name">$title</span><span class="var-description">: <p>- the title for the table</p></span> </li> |
| 530 |
<li> |
| 531 |
<span class="var-type">boolean</span> |
| 532 |
<span class="var-name">$show_buttons</span><span class="var-description">: <p>- show the action buttons?</p></span> </li> |
| 533 |
</ul> |
| 534 |
|
| 535 |
<hr class="separator" /> |
| 536 |
<div class="notes">Redefinition of:</div> |
| 537 |
<dl> |
| 538 |
<dt><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform_confirm">FormContent::form_confirm()</a></dt> |
| 539 |
<dd>This function is used to show an intermediary confirmation page. Use this function to show a confirmation of the data that was submitted by the user.</dd> |
| 540 |
</dl> |
| 541 |
|
| 542 |
</div> |
| 543 |
<a name="methodform_content" id="form_content"><!-- --></a> |
| 544 |
<div class="oddrow"> |
| 545 |
|
| 546 |
<div class="method-header"> |
| 547 |
<span class="method-title">form_content</span> (line <span class="line-number">89</span>) |
| 548 |
</div> |
| 549 |
|
| 550 |
<!-- ========== Info from phpDoc block ========= --> |
| 551 |
<p class="short-description">Child class MUST override this to provide the form fields</p> |
| 552 |
|
| 553 |
<div class="method-signature"> |
| 554 |
<span class="method-result">object</span> |
| 555 |
<span class="method-name"> |
| 556 |
form_content |
| 557 |
</span> |
| 558 |
() |
| 559 |
</div> |
| 560 |
|
| 561 |
|
| 562 |
|
| 563 |
<hr class="separator" /> |
| 564 |
<div class="notes">Redefined in descendants as:</div> |
| 565 |
<ul class="redefinitions"> |
| 566 |
<li> |
| 567 |
<a href="../../phpHtmlLib/form-examples/Step1.html#methodform_content">Step1::form_content()</a> |
| 568 |
: This method is called by the StandardFormContent object to allow you to build the 'blocks' of fields you want to display. Each form block will live inside a fieldset tag with the a title. |
| 569 |
</li> |
| 570 |
<li> |
| 571 |
<a href="../../phpHtmlLib/form-examples/Step2.html#methodform_content">Step2::form_content()</a> |
| 572 |
: This method is called by the StandardFormContent object to allow you to build the 'blocks' of fields you want to display. Each form block will live inside a fieldset tag with the a title. |
| 573 |
</li> |
| 574 |
<li> |
| 575 |
<a href="../../phpHtmlLib/form-examples/Step3.html#methodform_content">Step3::form_content()</a> |
| 576 |
: This method is called by the StandardFormContent object to allow you to build the 'blocks' of fields you want to display. Each form block will live inside a fieldset tag with the a title. |
| 577 |
</li> |
| 578 |
<li> |
| 579 |
<a href="../../phpHtmlLib/form-examples/StandardAccountForm.html#methodform_content">StandardAccountForm::form_content()</a> |
| 580 |
: This method is called by the StandardFormContent object to allow you to build the 'blocks' of fields you want to display. Each form block will live inside a fieldset tag with the a title. |
| 581 |
</li> |
| 582 |
</ul> |
| 583 |
</div> |
| 584 |
<a name="methodform_content_buttons" id="form_content_buttons"><!-- --></a> |
| 585 |
<div class="evenrow"> |
| 586 |
|
| 587 |
<div class="method-header"> |
| 588 |
<span class="method-title">form_content_buttons</span> (line <span class="line-number">172</span>) |
| 589 |
</div> |
| 590 |
|
| 591 |
<!-- ========== Info from phpDoc block ========= --> |
| 592 |
<p class="short-description">This function is used to build the standard buttons for a form.</p> |
| 593 |
|
| 594 |
<div class="method-signature"> |
| 595 |
<span class="method-result">ButtonPanel</span> |
| 596 |
<span class="method-name"> |
| 597 |
form_content_buttons |
| 598 |
</span> |
| 599 |
() |
| 600 |
</div> |
| 601 |
|
| 602 |
|
| 603 |
|
| 604 |
</div> |
| 605 |
<a name="methodset_form_title" id="set_form_title"><!-- --></a> |
| 606 |
<div class="oddrow"> |
| 607 |
|
| 608 |
<div class="method-header"> |
| 609 |
<span class="method-title">set_form_title</span> (line <span class="line-number">56</span>) |
| 610 |
</div> |
| 611 |
|
| 612 |
<!-- ========== Info from phpDoc block ========= --> |
| 613 |
<p class="short-description">this method sets the form title which is used to wrap the entire form</p> |
| 614 |
|
| 615 |
<div class="method-signature"> |
| 616 |
<span class="method-result">void</span> |
| 617 |
<span class="method-name"> |
| 618 |
set_form_title |
| 619 |
</span> |
| 620 |
(<span class="var-type">string</span> <span class="var-name">$title</span>) |
| 621 |
</div> |
| 622 |
|
| 623 |
<ul class="parameters"> |
| 624 |
<li> |
| 625 |
<span class="var-type">string</span> |
| 626 |
<span class="var-name">$title</span><span class="var-description">: <p>- the form title</p></span> </li> |
| 627 |
</ul> |
| 628 |
|
| 629 |
|
| 630 |
</div> |
| 631 |
<a name="method_div_wrapper" id="_div_wrapper"><!-- --></a> |
| 632 |
<div class="evenrow"> |
| 633 |
|
| 634 |
<div class="method-header"> |
| 635 |
<span class="method-title">_div_wrapper</span> (line <span class="line-number">219</span>) |
| 636 |
</div> |
| 637 |
|
| 638 |
<!-- ========== Info from phpDoc block ========= --> |
| 639 |
|
| 640 |
<div class="method-signature"> |
| 641 |
<span class="method-result">void</span> |
| 642 |
<span class="method-name"> |
| 643 |
&_div_wrapper |
| 644 |
</span> |
| 645 |
() |
| 646 |
</div> |
| 647 |
|
| 648 |
|
| 649 |
|
| 650 |
</div> |
| 651 |
<a name="method_form_content_table" id="_form_content_table"><!-- --></a> |
| 652 |
<div class="oddrow"> |
| 653 |
|
| 654 |
<div class="method-header"> |
| 655 |
<span class="method-title">_form_content_table</span> (line <span class="line-number">225</span>) |
| 656 |
</div> |
| 657 |
|
| 658 |
<!-- ========== Info from phpDoc block ========= --> |
| 659 |
|
| 660 |
<div class="method-signature"> |
| 661 |
<span class="method-result">void</span> |
| 662 |
<span class="method-name"> |
| 663 |
_form_content_table |
| 664 |
</span> |
| 665 |
([<span class="var-type">mixed</span> <span class="var-name">$width</span> = <span class="var-default">"100%"</span>], <span class="var-type">mixed</span> <span class="var-name">$border</span>, <span class="var-type">mixed</span> <span class="var-name">$cellspacing</span>, [<span class="var-type">mixed</span> <span class="var-name">$cellpadding</span> = <span class="var-default">3</span>]) |
| 666 |
</div> |
| 667 |
|
| 668 |
|
| 669 |
|
| 670 |
</div> |
| 671 |
<h4>Inherited Methods</h4> |
| 672 |
<a name='inherited_methods'><!-- --></a> |
| 673 |
<!-- =========== Summary =========== --> |
| 674 |
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormContent.html">FormContent</a></span></p> |
| 675 |
<blockquote> |
| 676 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodFormContent">FormContent::FormContent()</a></span><br> |
| 677 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodadd_action">FormContent::add_action()</a></span><br> |
| 678 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodadd_cancel">FormContent::add_cancel()</a></span><br> |
| 679 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodadd_element">FormContent::add_element()</a></span><br> |
| 680 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodadd_error">FormContent::add_error()</a></span><br> |
| 681 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodadd_hidden_action">FormContent::add_hidden_action()</a></span><br> |
| 682 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodadd_hidden_element">FormContent::add_hidden_element()</a></span><br> |
| 683 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodadd_image_action">FormContent::add_image_action()</a></span><br> |
| 684 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodbuild_confirm_table">FormContent::build_confirm_table()</a></span><br> |
| 685 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodelement_form">FormContent::element_form()</a></span><br> |
| 686 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodelement_label">FormContent::element_label()</a></span><br> |
| 687 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform">FormContent::form()</a></span><br> |
| 688 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform_action">FormContent::form_action()</a></span><br> |
| 689 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform_backend_validation">FormContent::form_backend_validation()</a></span><br> |
| 690 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform_confirm">FormContent::form_confirm()</a></span><br> |
| 691 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform_errors">FormContent::form_errors()</a></span><br> |
| 692 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform_init_data">FormContent::form_init_data()</a></span><br> |
| 693 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform_init_elements">FormContent::form_init_elements()</a></span><br> |
| 694 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodform_success">FormContent::form_success()</a></span><br> |
| 695 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodget_action">FormContent::get_action()</a></span><br> |
| 696 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodget_default_css">FormContent::get_default_css()</a></span><br> |
| 697 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodget_element">FormContent::get_element()</a></span><br> |
| 698 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodget_element_value">FormContent::get_element_value()</a></span><br> |
| 699 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodget_error_array">FormContent::get_error_array()</a></span><br> |
| 700 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodget_form_errors_width">FormContent::get_form_errors_width()</a></span><br> |
| 701 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodget_hidden_element_value">FormContent::get_hidden_element_value()</a></span><br> |
| 702 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodget_required_fields_text">FormContent::get_required_fields_text()</a></span><br> |
| 703 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodhas_confirm">FormContent::has_confirm()</a></span><br> |
| 704 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodhidden_element_label">FormContent::hidden_element_label()</a></span><br> |
| 705 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodjavascript">FormContent::javascript()</a></span><br> |
| 706 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodpre_confirm">FormContent::pre_confirm()</a></span><br> |
| 707 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_action">FormContent::set_action()</a></span><br> |
| 708 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_action_message">FormContent::set_action_message()</a></span><br> |
| 709 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_cancel_action">FormContent::set_cancel_action()</a></span><br> |
| 710 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_confirm">FormContent::set_confirm()</a></span><br> |
| 711 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_default_css">FormContent::set_default_css()</a></span><br> |
| 712 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_element_value">FormContent::set_element_value()</a></span><br> |
| 713 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_error_css">FormContent::set_error_css()</a></span><br> |
| 714 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_form_errors_title">FormContent::set_form_errors_title()</a></span><br> |
| 715 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_form_errors_width">FormContent::set_form_errors_width()</a></span><br> |
| 716 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_form_name">FormContent::set_form_name()</a></span><br> |
| 717 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_form_width">FormContent::set_form_width()</a></span><br> |
| 718 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_hidden_element_value">FormContent::set_hidden_element_value()</a></span><br> |
| 719 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_required_marker">FormContent::set_required_marker()</a></span><br> |
| 720 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_required_text">FormContent::set_required_text()</a></span><br> |
| 721 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#methodset_stripslashes">FormContent::set_stripslashes()</a></span><br> |
| 722 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormContent.html#method_test_element">FormContent::_test_element()</a></span><br> |
| 723 |
</blockquote> |
| 724 |
|
| 725 |
</div> |
| 726 |
</div> |
| 727 |
|
| 728 |
<p class="notes" id="credit"> |
| 729 |
Documention generated on Thu, 31 Jul 2003 18:33:00 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a> |
| 730 |
</p> |
| 731 |
</div></body> |
| 732 |
</html> |
Parent Directory
| 
Revision Log
