| 1 |
jonen |
1.3 |
<?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 FormElement</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 FormElement</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 the base FormElement object. It can be single form field such as a text input field, or a complex object.</p>
|
| 27 |
|
|
<p class="description"><p>Usefull Functions</p><p>get_value() - This gets the current 'value' of the FormElement. NOTE: This can be a 'complex' FormElement in which it may return an array of values.</p><p>set_value() - Set the current value for this FormElement.</p><p>get_label() - returns the label for this FormElement.</p></p>
|
| 28 |
|
|
<p class="notes">
|
| 29 |
|
|
Located in <a class="field" href="_form_FormElement_inc.html">/form/FormElement.inc</a> (line <span class="field">39</span>)
|
| 30 |
|
|
</p>
|
| 31 |
|
|
|
| 32 |
|
|
|
| 33 |
|
|
<pre></pre>
|
| 34 |
|
|
|
| 35 |
|
|
</div>
|
| 36 |
|
|
</div>
|
| 37 |
|
|
|
| 38 |
|
|
<a name="sec-descendents"></a>
|
| 39 |
|
|
<div class="info-box">
|
| 40 |
|
|
<div class="info-box-title">Direct descendents</div>
|
| 41 |
|
|
<div class="nav-bar">
|
| 42 |
|
|
<a href="#sec-description">Description</a> |
|
| 43 |
|
|
<span class="disabled">Descendents</span>
|
| 44 |
|
|
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
| 45 |
|
|
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
| 46 |
|
|
|
| 47 |
|
|
</div>
|
| 48 |
|
|
<div class="info-box-body">
|
| 49 |
|
|
<table cellpadding="2" cellspacing="0" class="class-table">
|
| 50 |
|
|
<tr>
|
| 51 |
|
|
<th class="class-table-header">Class</th>
|
| 52 |
|
|
<th class="class-table-header">Description</th>
|
| 53 |
|
|
</tr>
|
| 54 |
|
|
<tr>
|
| 55 |
|
|
<td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></td>
|
| 56 |
|
|
<td>
|
| 57 |
|
|
This is the Box FormElement which builds a DIV with a width and a height. It is a base class for more complicated FormElements.
|
| 58 |
|
|
</td>
|
| 59 |
|
|
</tr>
|
| 60 |
|
|
<tr>
|
| 61 |
|
|
<td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FECheckBox.html">FECheckBox</a></td>
|
| 62 |
|
|
<td>
|
| 63 |
|
|
This is the CheckBox FormElement which builds a input field of type="checkbox". It has no validation method.
|
| 64 |
|
|
</td>
|
| 65 |
|
|
</tr>
|
| 66 |
|
|
<tr>
|
| 67 |
|
|
<td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FERadioGroup.html">FERadioGroup</a></td>
|
| 68 |
|
|
<td>
|
| 69 |
|
|
This is the Radio Button Group FormElement which builds a List of Radio buttons that can be used in any style of layout.
|
| 70 |
|
|
</td>
|
| 71 |
|
|
</tr>
|
| 72 |
|
|
<tr>
|
| 73 |
|
|
<td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEText.html">FEText</a></td>
|
| 74 |
|
|
<td>
|
| 75 |
|
|
This is the Text FormElement which builds a text input field. It has no validation method.
|
| 76 |
|
|
</td>
|
| 77 |
|
|
</tr>
|
| 78 |
|
|
<tr>
|
| 79 |
|
|
<td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEHidden.html">FEHidden</a></td>
|
| 80 |
|
|
<td>
|
| 81 |
|
|
This is the Hidden FormElement which builds a input field of type="hidden". It has no validation method.
|
| 82 |
|
|
</td>
|
| 83 |
|
|
</tr>
|
| 84 |
|
|
<tr>
|
| 85 |
|
|
<td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEError.html">FEError</a></td>
|
| 86 |
|
|
<td>
|
| 87 |
|
|
This is a way of providing an Error to the FormProcessor.
|
| 88 |
|
|
</td>
|
| 89 |
|
|
</tr>
|
| 90 |
|
|
</table>
|
| 91 |
|
|
</div>
|
| 92 |
|
|
</div>
|
| 93 |
|
|
|
| 94 |
|
|
|
| 95 |
|
|
<a name="sec-var-summary"></a>
|
| 96 |
|
|
<div class="info-box">
|
| 97 |
|
|
<div class="info-box-title">Variable Summary</span></div>
|
| 98 |
|
|
<div class="nav-bar">
|
| 99 |
|
|
<a href="#sec-description">Description</a> |
|
| 100 |
|
|
<a href="#sec-descendents">Descendents</a> |
|
| 101 |
|
|
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
| 102 |
|
|
|
|
| 103 |
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
| 104 |
|
|
|
| 105 |
|
|
</div>
|
| 106 |
|
|
<div class="info-box-body">
|
| 107 |
|
|
<div class="var-summary">
|
| 108 |
|
|
<div class="var-title">
|
| 109 |
|
|
<span class="var-type">mixed</span>
|
| 110 |
|
|
<a href="#$_attributes" title="details" class="var-name">$_attributes</a>
|
| 111 |
|
|
</div>
|
| 112 |
|
|
<div class="var-title">
|
| 113 |
|
|
<span class="var-type">mixed</span>
|
| 114 |
|
|
<a href="#$_element_name" title="details" class="var-name">$_element_name</a>
|
| 115 |
|
|
</div>
|
| 116 |
|
|
<div class="var-title">
|
| 117 |
|
|
<span class="var-type">mixed</span>
|
| 118 |
|
|
<a href="#$_errors" title="details" class="var-name">$_errors</a>
|
| 119 |
|
|
</div>
|
| 120 |
|
|
<div class="var-title">
|
| 121 |
|
|
<span class="var-type">mixed</span>
|
| 122 |
|
|
<a href="#$_error_message" title="details" class="var-name">$_error_message</a>
|
| 123 |
|
|
</div>
|
| 124 |
|
|
<div class="var-title">
|
| 125 |
|
|
<span class="var-type">mixed</span>
|
| 126 |
|
|
<a href="#$_form_name" title="details" class="var-name">$_form_name</a>
|
| 127 |
|
|
</div>
|
| 128 |
|
|
<div class="var-title">
|
| 129 |
|
|
<span class="var-type">mixed</span>
|
| 130 |
|
|
<a href="#$_has_error" title="details" class="var-name">$_has_error</a>
|
| 131 |
|
|
</div>
|
| 132 |
|
|
<div class="var-title">
|
| 133 |
|
|
<span class="var-type">string</span>
|
| 134 |
|
|
<a href="#$_has_form_on_submit" title="details" class="var-name">$_has_form_on_submit</a>
|
| 135 |
|
|
</div>
|
| 136 |
|
|
<div class="var-title">
|
| 137 |
|
|
<span class="var-type">mixed</span>
|
| 138 |
|
|
<a href="#$_is_disabled" title="details" class="var-name">$_is_disabled</a>
|
| 139 |
|
|
</div>
|
| 140 |
|
|
<div class="var-title">
|
| 141 |
|
|
<span class="var-type">mixed</span>
|
| 142 |
|
|
<a href="#$_is_required" title="details" class="var-name">$_is_required</a>
|
| 143 |
|
|
</div>
|
| 144 |
|
|
<div class="var-title">
|
| 145 |
|
|
<span class="var-type">mixed</span>
|
| 146 |
|
|
<a href="#$_label_text" title="details" class="var-name">$_label_text</a>
|
| 147 |
|
|
</div>
|
| 148 |
|
|
<div class="var-title">
|
| 149 |
|
|
<span class="var-type">mixed</span>
|
| 150 |
|
|
<a href="#$_required_field_marker" title="details" class="var-name">$_required_field_marker</a>
|
| 151 |
|
|
</div>
|
| 152 |
|
|
<div class="var-title">
|
| 153 |
|
|
<span class="var-type">mixed</span>
|
| 154 |
|
|
<a href="#$_slave_elements" title="details" class="var-name">$_slave_elements</a>
|
| 155 |
|
|
</div>
|
| 156 |
|
|
<div class="var-title">
|
| 157 |
|
|
<span class="var-type">mixed</span>
|
| 158 |
|
|
<a href="#$_stripslashes" title="details" class="var-name">$_stripslashes</a>
|
| 159 |
|
|
</div>
|
| 160 |
|
|
<div class="var-title">
|
| 161 |
|
|
<span class="var-type">mixed</span>
|
| 162 |
|
|
<a href="#$_style_attributes" title="details" class="var-name">$_style_attributes</a>
|
| 163 |
|
|
</div>
|
| 164 |
|
|
<div class="var-title">
|
| 165 |
|
|
<span class="var-type">mixed</span>
|
| 166 |
|
|
<a href="#$_value" title="details" class="var-name">$_value</a>
|
| 167 |
|
|
</div>
|
| 168 |
|
|
</div>
|
| 169 |
|
|
</div>
|
| 170 |
|
|
</div>
|
| 171 |
|
|
|
| 172 |
|
|
<a name="sec-method-summary"></a>
|
| 173 |
|
|
<div class="info-box">
|
| 174 |
|
|
<div class="info-box-title">Method Summary</span></div>
|
| 175 |
|
|
<div class="nav-bar">
|
| 176 |
|
|
<a href="#sec-description">Description</a> |
|
| 177 |
|
|
<a href="#sec-descendents">Descendents</a> |
|
| 178 |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
| 179 |
|
|
|
| 180 |
|
|
|
|
| 181 |
|
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
| 182 |
|
|
</div>
|
| 183 |
|
|
<div class="info-box-body">
|
| 184 |
|
|
<div class="method-summary">
|
| 185 |
|
|
|
| 186 |
|
|
<div class="method-definition">
|
| 187 |
|
|
<span class="method-result">FormElement</span>
|
| 188 |
|
|
<a href="#FormElement" title="details" class="method-name">FormElement</a>
|
| 189 |
|
|
(<span class="var-type">label</span> <span class="var-name">$label</span>, [<span class="var-type">bool</span> <span class="var-name">$required</span> = <span class="var-default">TRUE</span>])
|
| 190 |
|
|
</div>
|
| 191 |
|
|
|
| 192 |
|
|
<div class="method-definition">
|
| 193 |
|
|
<span class="method-result">void</span>
|
| 194 |
|
|
<a href="#create_element_name" title="details" class="method-name">create_element_name</a>
|
| 195 |
|
|
()
|
| 196 |
|
|
</div>
|
| 197 |
|
|
|
| 198 |
|
|
<div class="method-definition">
|
| 199 |
|
|
<span class="method-result">string</span>
|
| 200 |
|
|
<a href="#form_tag_onsubmit" title="details" class="method-name">form_tag_onsubmit</a>
|
| 201 |
|
|
()
|
| 202 |
|
|
</div>
|
| 203 |
|
|
|
| 204 |
|
|
<div class="method-definition">
|
| 205 |
|
|
<span class="method-result">mixed</span>
|
| 206 |
|
|
<a href="#get_attribute" title="details" class="method-name">get_attribute</a>
|
| 207 |
|
|
(<span class="var-type">string</span> <span class="var-name">$name</span>)
|
| 208 |
|
|
</div>
|
| 209 |
|
|
|
| 210 |
|
|
<div class="method-definition">
|
| 211 |
|
|
<span class="method-result"><a href="../../phpHtmlLib/INPUTtag.html">INPUTtag</a></span>
|
| 212 |
|
|
<a href="#get_confirm_element" title="details" class="method-name">get_confirm_element</a>
|
| 213 |
|
|
()
|
| 214 |
|
|
</div>
|
| 215 |
|
|
|
| 216 |
|
|
<div class="method-definition">
|
| 217 |
|
|
<span class="method-result">object</span>
|
| 218 |
|
|
<a href="#get_element" title="details" class="method-name">get_element</a>
|
| 219 |
|
|
()
|
| 220 |
|
|
</div>
|
| 221 |
|
|
|
| 222 |
|
|
<div class="method-definition">
|
| 223 |
|
|
<span class="method-result">string</span>
|
| 224 |
|
|
<a href="#get_element_name" title="details" class="method-name">get_element_name</a>
|
| 225 |
|
|
()
|
| 226 |
|
|
</div>
|
| 227 |
|
|
|
| 228 |
|
|
<div class="method-definition">
|
| 229 |
|
|
<span class="method-result">void</span>
|
| 230 |
|
|
<a href="#get_errors" title="details" class="method-name">get_errors</a>
|
| 231 |
|
|
(<span class="var-type">array</span> <span class="var-name">0</span>)
|
| 232 |
|
|
</div>
|
| 233 |
|
|
|
| 234 |
|
|
<div class="method-definition">
|
| 235 |
|
|
<span class="method-result">mesage</span>
|
| 236 |
|
|
<a href="#get_error_message" title="details" class="method-name">get_error_message</a>
|
| 237 |
|
|
()
|
| 238 |
|
|
</div>
|
| 239 |
|
|
|
| 240 |
|
|
<div class="method-definition">
|
| 241 |
|
|
<span class="method-result">mixed</span>
|
| 242 |
|
|
<a href="#get_init_value" title="details" class="method-name">get_init_value</a>
|
| 243 |
|
|
()
|
| 244 |
|
|
</div>
|
| 245 |
|
|
|
| 246 |
|
|
<div class="method-definition">
|
| 247 |
|
|
<span class="method-result"><a href="../../phpHtmlLib/SPANtag.html">object SPANtag</a></span>
|
| 248 |
|
|
<a href="#get_label" title="details" class="method-name">get_label</a>
|
| 249 |
|
|
([<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormContent.html">FormContent</a></span> <span class="var-name">$form_content</span> = <span class="var-default">NULL</span>])
|
| 250 |
|
|
</div>
|
| 251 |
|
|
|
| 252 |
|
|
<div class="method-definition">
|
| 253 |
|
|
<span class="method-result">string</span>
|
| 254 |
|
|
<a href="#get_label_text" title="details" class="method-name">get_label_text</a>
|
| 255 |
|
|
()
|
| 256 |
|
|
</div>
|
| 257 |
|
|
|
| 258 |
|
|
<div class="method-definition">
|
| 259 |
|
|
<span class="method-result">string</span>
|
| 260 |
|
|
<a href="#get_required_symbol" title="details" class="method-name">get_required_symbol</a>
|
| 261 |
|
|
()
|
| 262 |
|
|
</div>
|
| 263 |
|
|
|
| 264 |
|
|
<div class="method-definition">
|
| 265 |
|
|
<span class="method-result">array</span>
|
| 266 |
|
|
<a href="#get_slave_elements" title="details" class="method-name">&get_slave_elements</a>
|
| 267 |
|
|
()
|
| 268 |
|
|
</div>
|
| 269 |
|
|
|
| 270 |
|
|
<div class="method-definition">
|
| 271 |
|
|
<span class="method-result">int</span>
|
| 272 |
|
|
<a href="#get_tabindex" title="details" class="method-name">get_tabindex</a>
|
| 273 |
|
|
()
|
| 274 |
|
|
</div>
|
| 275 |
|
|
|
| 276 |
|
|
<div class="method-definition">
|
| 277 |
|
|
<span class="method-result">mixed</span>
|
| 278 |
|
|
<a href="#get_value" title="details" class="method-name">get_value</a>
|
| 279 |
|
|
()
|
| 280 |
|
|
</div>
|
| 281 |
|
|
|
| 282 |
|
|
<div class="method-definition">
|
| 283 |
|
|
<span class="method-result">string</span>
|
| 284 |
|
|
<a href="#get_value_text" title="details" class="method-name">get_value_text</a>
|
| 285 |
|
|
(<span class="var-type">mixed</span> <span class="var-name">0</span>)
|
| 286 |
|
|
</div>
|
| 287 |
|
|
|
| 288 |
|
|
<div class="method-definition">
|
| 289 |
|
|
<span class="method-result">bool</span>
|
| 290 |
|
|
<a href="#has_error" title="details" class="method-name">has_error</a>
|
| 291 |
|
|
([<span class="var-type">mixed</span> <span class="var-name">$label</span> = <span class="var-default">NULL</span>])
|
| 292 |
|
|
</div>
|
| 293 |
|
|
|
| 294 |
|
|
<div class="method-definition">
|
| 295 |
|
|
<span class="method-result">bool</span>
|
| 296 |
|
|
<a href="#is_disabled" title="details" class="method-name">is_disabled</a>
|
| 297 |
|
|
()
|
| 298 |
|
|
</div>
|
| 299 |
|
|
|
| 300 |
|
|
<div class="method-definition">
|
| 301 |
|
|
<span class="method-result">bool</span>
|
| 302 |
|
|
<a href="#is_required" title="details" class="method-name">is_required</a>
|
| 303 |
|
|
()
|
| 304 |
|
|
</div>
|
| 305 |
|
|
|
| 306 |
|
|
<div class="method-definition">
|
| 307 |
|
|
<span class="method-result">string</span>
|
| 308 |
|
|
<a href="#javascript" title="details" class="method-name">javascript</a>
|
| 309 |
|
|
()
|
| 310 |
|
|
</div>
|
| 311 |
|
|
|
| 312 |
|
|
<div class="method-definition">
|
| 313 |
|
|
<span class="method-result">string</span>
|
| 314 |
|
|
<a href="#onBlur" title="details" class="method-name">onBlur</a>
|
| 315 |
|
|
()
|
| 316 |
|
|
</div>
|
| 317 |
|
|
|
| 318 |
|
|
<div class="method-definition">
|
| 319 |
|
|
<span class="method-result">string</span>
|
| 320 |
|
|
<a href="#onChange" title="details" class="method-name">onChange</a>
|
| 321 |
|
|
()
|
| 322 |
|
|
</div>
|
| 323 |
|
|
|
| 324 |
|
|
<div class="method-definition">
|
| 325 |
|
|
<span class="method-result">string</span>
|
| 326 |
|
|
<a href="#onClick" title="details" class="method-name">onClick</a>
|
| 327 |
|
|
()
|
| 328 |
|
|
</div>
|
| 329 |
|
|
|
| 330 |
|
|
<div class="method-definition">
|
| 331 |
|
|
<span class="method-result">string</span>
|
| 332 |
|
|
<a href="#onFocus" title="details" class="method-name">onFocus</a>
|
| 333 |
|
|
()
|
| 334 |
|
|
</div>
|
| 335 |
|
|
|
| 336 |
|
|
<div class="method-definition">
|
| 337 |
|
|
<span class="method-result">string</span>
|
| 338 |
|
|
<a href="#onSubmit" title="details" class="method-name">onSubmit</a>
|
| 339 |
|
|
()
|
| 340 |
|
|
</div>
|
| 341 |
|
|
|
| 342 |
|
|
<div class="method-definition">
|
| 343 |
|
|
<span class="method-result">void</span>
|
| 344 |
|
|
<a href="#set_attribute" title="details" class="method-name">set_attribute</a>
|
| 345 |
|
|
(<span class="var-type">string</span> <span class="var-name">$name</span>, [<span class="var-type">mixed</span> <span class="var-name">$value</span> = <span class="var-default">NULL</span>])
|
| 346 |
|
|
</div>
|
| 347 |
|
|
|
| 348 |
|
|
<div class="method-definition">
|
| 349 |
|
|
<span class="method-result">void</span>
|
| 350 |
|
|
<a href="#set_data_all_slaves" title="details" class="method-name">set_data_all_slaves</a>
|
| 351 |
|
|
(<span class="var-type">string</span> <span class="var-name">$parentValue</span>)
|
| 352 |
|
|
</div>
|
| 353 |
|
|
|
| 354 |
|
|
<div class="method-definition">
|
| 355 |
|
|
<span class="method-result">void</span>
|
| 356 |
|
|
<a href="#set_disabled" title="details" class="method-name">set_disabled</a>
|
| 357 |
|
|
(<span class="var-type">bool</span> <span class="var-name">$flag</span>)
|
| 358 |
|
|
</div>
|
| 359 |
|
|
|
| 360 |
|
|
<div class="method-definition">
|
| 361 |
|
|
<span class="method-result">none</span>
|
| 362 |
|
|
<a href="#set_element_name" title="details" class="method-name">set_element_name</a>
|
| 363 |
|
|
(<span class="var-type">string</span> <span class="var-name">$name</span>)
|
| 364 |
|
|
</div>
|
| 365 |
|
|
|
| 366 |
|
|
<div class="method-definition">
|
| 367 |
|
|
<span class="method-result">void</span>
|
| 368 |
|
|
<a href="#set_error_message" title="details" class="method-name">set_error_message</a>
|
| 369 |
|
|
(<span class="var-type">mesage</span> <span class="var-name">$message</span>, [<span class="var-type">label</span> <span class="var-name">$label</span> = <span class="var-default">NULL</span>])
|
| 370 |
|
|
</div>
|
| 371 |
|
|
|
| 372 |
|
|
<div class="method-definition">
|
| 373 |
|
|
<span class="method-result">void</span>
|
| 374 |
|
|
<a href="#set_form_name" title="details" class="method-name">set_form_name</a>
|
| 375 |
|
|
(<span class="var-type">string</span> <span class="var-name">$name</span>)
|
| 376 |
|
|
</div>
|
| 377 |
|
|
|
| 378 |
|
|
<div class="method-definition">
|
| 379 |
|
|
<span class="method-result">void</span>
|
| 380 |
|
|
<a href="#set_label_text" title="details" class="method-name">set_label_text</a>
|
| 381 |
|
|
(<span class="var-type">label</span> <span class="var-name">$label</span>)
|
| 382 |
|
|
</div>
|
| 383 |
|
|
|
| 384 |
|
|
<div class="method-definition">
|
| 385 |
|
|
<span class="method-result">void</span>
|
| 386 |
|
|
<a href="#set_required" title="details" class="method-name">set_required</a>
|
| 387 |
|
|
(<span class="var-type">bool</span> <span class="var-name">$required</span>)
|
| 388 |
|
|
</div>
|
| 389 |
|
|
|
| 390 |
|
|
<div class="method-definition">
|
| 391 |
|
|
<span class="method-result">void</span>
|
| 392 |
|
|
<a href="#set_required_symbol" title="details" class="method-name">set_required_symbol</a>
|
| 393 |
|
|
(<span class="var-type">string</span> <span class="var-name">$symbol</span>)
|
| 394 |
|
|
</div>
|
| 395 |
|
|
|
| 396 |
|
|
<div class="method-definition">
|
| 397 |
|
|
<span class="method-result">void</span>
|
| 398 |
|
|
<a href="#set_slave_data" title="details" class="method-name">set_slave_data</a>
|
| 399 |
|
|
(<span class="var-type">the</span> <span class="var-name">&$slave</span>, <span class="var-type">the</span> <span class="var-name">$parentValue</span>)
|
| 400 |
|
|
</div>
|
| 401 |
|
|
|
| 402 |
|
|
<div class="method-definition">
|
| 403 |
|
|
<span class="method-result">void</span>
|
| 404 |
|
|
<a href="#set_slave_elements" title="details" class="method-name">set_slave_elements</a>
|
| 405 |
|
|
(<span class="var-type">array</span> <span class="var-name">$slaveElements</span>)
|
| 406 |
|
|
</div>
|
| 407 |
|
|
|
| 408 |
|
|
<div class="method-definition">
|
| 409 |
|
|
<span class="method-result">void</span>
|
| 410 |
|
|
<a href="#set_stripslashes" title="details" class="method-name">set_stripslashes</a>
|
| 411 |
|
|
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>])
|
| 412 |
|
|
</div>
|
| 413 |
|
|
|
| 414 |
|
|
<div class="method-definition">
|
| 415 |
|
|
<span class="method-result">void</span>
|
| 416 |
|
|
<a href="#set_style_attribute" title="details" class="method-name">set_style_attribute</a>
|
| 417 |
|
|
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">mixed</span> <span class="var-name">$value</span>)
|
| 418 |
|
|
</div>
|
| 419 |
|
|
|
| 420 |
|
|
<div class="method-definition">
|
| 421 |
|
|
<span class="method-result">void</span>
|
| 422 |
|
|
<a href="#set_tabindex" title="details" class="method-name">set_tabindex</a>
|
| 423 |
|
|
(<span class="var-type">int</span> <span class="var-name">$index</span>)
|
| 424 |
|
|
</div>
|
| 425 |
|
|
|
| 426 |
|
|
<div class="method-definition">
|
| 427 |
|
|
<span class="method-result">void</span>
|
| 428 |
|
|
<a href="#set_title" title="details" class="method-name">set_title</a>
|
| 429 |
|
|
(<span class="var-type">string</span> <span class="var-name">$title</span>)
|
| 430 |
|
|
</div>
|
| 431 |
|
|
|
| 432 |
|
|
<div class="method-definition">
|
| 433 |
|
|
<span class="method-result">void</span>
|
| 434 |
|
|
<a href="#set_value" title="details" class="method-name">set_value</a>
|
| 435 |
|
|
(<span class="var-type">value</span> <span class="var-name">$value</span>)
|
| 436 |
|
|
</div>
|
| 437 |
|
|
|
| 438 |
|
|
<div class="method-definition">
|
| 439 |
|
|
<span class="method-result">void</span>
|
| 440 |
|
|
<a href="#validate" title="details" class="method-name">validate</a>
|
| 441 |
|
|
(<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span> <span class="var-name">&$_FormValidation</span>)
|
| 442 |
|
|
</div>
|
| 443 |
|
|
|
| 444 |
|
|
<div class="method-definition">
|
| 445 |
|
|
<span class="method-result">array</span>
|
| 446 |
|
|
<a href="#_build_element_attributes" title="details" class="method-name">_build_element_attributes</a>
|
| 447 |
|
|
()
|
| 448 |
|
|
</div>
|
| 449 |
|
|
|
| 450 |
|
|
<div class="method-definition">
|
| 451 |
|
|
<span class="method-result">array</span>
|
| 452 |
|
|
<a href="#_build_javascript" title="details" class="method-name">_build_javascript</a>
|
| 453 |
|
|
()
|
| 454 |
|
|
</div>
|
| 455 |
|
|
|
| 456 |
|
|
<div class="method-definition">
|
| 457 |
|
|
<span class="method-result">void</span>
|
| 458 |
|
|
<a href="#_do_validation" title="details" class="method-name">_do_validation</a>
|
| 459 |
|
|
(<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span> <span class="var-name">&$_FormValidation</span>)
|
| 460 |
|
|
</div>
|
| 461 |
|
|
</div>
|
| 462 |
|
|
</div>
|
| 463 |
|
|
</div>
|
| 464 |
|
|
|
| 465 |
|
|
<a name="sec-vars"></a>
|
| 466 |
|
|
<div class="info-box">
|
| 467 |
|
|
<div class="info-box-title">Variables</div>
|
| 468 |
|
|
<div class="nav-bar">
|
| 469 |
|
|
<a href="#sec-description">Description</a> |
|
| 470 |
|
|
<a href="#sec-descendents">Descendents</a> |
|
| 471 |
|
|
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
| 472 |
|
|
|
| 473 |
|
|
|
| 474 |
|
|
|
|
| 475 |
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
| 476 |
|
|
|
| 477 |
|
|
</div>
|
| 478 |
|
|
<div class="info-box-body">
|
| 479 |
|
|
<a name="var$_attributes" id="$_attributes"><!-- --></A>
|
| 480 |
|
|
<div class="oddrow">
|
| 481 |
|
|
|
| 482 |
|
|
<div class="var-header">
|
| 483 |
|
|
<span class="var-title">
|
| 484 |
|
|
<span class="var-type">mixed</span>
|
| 485 |
|
|
<span class="var-name">$_attributes</span>
|
| 486 |
|
|
(line <span class="line-number">92</span>)
|
| 487 |
|
|
</span>
|
| 488 |
|
|
</div>
|
| 489 |
|
|
|
| 490 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 491 |
|
|
<p class="short-description">Holds additional attributes for</p>
|
| 492 |
|
|
<p class="description"><p>the elements html tag</p></p>
|
| 493 |
|
|
|
| 494 |
|
|
|
| 495 |
|
|
|
| 496 |
|
|
|
| 497 |
|
|
|
| 498 |
|
|
</div>
|
| 499 |
|
|
<a name="var$_element_name" id="$_element_name"><!-- --></A>
|
| 500 |
|
|
<div class="evenrow">
|
| 501 |
|
|
|
| 502 |
|
|
<div class="var-header">
|
| 503 |
|
|
<span class="var-title">
|
| 504 |
|
|
<span class="var-type">mixed</span>
|
| 505 |
|
|
<span class="var-name">$_element_name</span>
|
| 506 |
|
|
= <span class="var-default"> NULL</span> (line <span class="line-number">85</span>)
|
| 507 |
|
|
</span>
|
| 508 |
|
|
</div>
|
| 509 |
|
|
|
| 510 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 511 |
|
|
<p class="short-description">Holds the name of the element</p>
|
| 512 |
|
|
<p class="description"><p>as it appears in the form html tag</p></p>
|
| 513 |
|
|
|
| 514 |
|
|
|
| 515 |
|
|
|
| 516 |
|
|
|
| 517 |
|
|
|
| 518 |
|
|
</div>
|
| 519 |
|
|
<a name="var$_errors" id="$_errors"><!-- --></A>
|
| 520 |
|
|
<div class="oddrow">
|
| 521 |
|
|
|
| 522 |
|
|
<div class="var-header">
|
| 523 |
|
|
<span class="var-title">
|
| 524 |
|
|
<span class="var-type">mixed</span>
|
| 525 |
|
|
<span class="var-name">$_errors</span>
|
| 526 |
|
|
= <span class="var-default">array()</span> (line <span class="line-number">64</span>)
|
| 527 |
|
|
</span>
|
| 528 |
|
|
</div>
|
| 529 |
|
|
|
| 530 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 531 |
|
|
<p class="short-description">holds the array of errors for this element.</p>
|
| 532 |
|
|
|
| 533 |
|
|
|
| 534 |
|
|
|
| 535 |
|
|
|
| 536 |
|
|
|
| 537 |
|
|
</div>
|
| 538 |
|
|
<a name="var$_error_message" id="$_error_message"><!-- --></A>
|
| 539 |
|
|
<div class="evenrow">
|
| 540 |
|
|
|
| 541 |
|
|
<div class="var-header">
|
| 542 |
|
|
<span class="var-title">
|
| 543 |
|
|
<span class="var-type">mixed</span>
|
| 544 |
|
|
<span class="var-name">$_error_message</span>
|
| 545 |
|
|
= <span class="var-default"> NULL</span> (line <span class="line-number">71</span>)
|
| 546 |
|
|
</span>
|
| 547 |
|
|
</div>
|
| 548 |
|
|
|
| 549 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 550 |
|
|
<p class="short-description">Holds the error message text</p>
|
| 551 |
|
|
<p class="description"><p>for validation errors, if any</p></p>
|
| 552 |
|
|
|
| 553 |
|
|
|
| 554 |
|
|
|
| 555 |
|
|
<hr class="separator" />
|
| 556 |
|
|
<div class="notes">Redefined in descendants as:</div>
|
| 557 |
|
|
<ul class="redefinitions">
|
| 558 |
|
|
<li>
|
| 559 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FERegEx.html#var$_error_message">FERegEx::$_error_message</a>
|
| 560 |
|
|
</li>
|
| 561 |
|
|
</ul>
|
| 562 |
|
|
|
| 563 |
|
|
|
| 564 |
|
|
</div>
|
| 565 |
|
|
<a name="var$_form_name" id="$_form_name"><!-- --></A>
|
| 566 |
|
|
<div class="oddrow">
|
| 567 |
|
|
|
| 568 |
|
|
<div class="var-header">
|
| 569 |
|
|
<span class="var-title">
|
| 570 |
|
|
<span class="var-type">mixed</span>
|
| 571 |
|
|
<span class="var-name">$_form_name</span>
|
| 572 |
|
|
(line <span class="line-number">118</span>)
|
| 573 |
|
|
</span>
|
| 574 |
|
|
</div>
|
| 575 |
|
|
|
| 576 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 577 |
|
|
<p class="short-description">This holds the name of the form</p>
|
| 578 |
|
|
<p class="description"><p>for js that needs it</p></p>
|
| 579 |
|
|
|
| 580 |
|
|
|
| 581 |
|
|
|
| 582 |
|
|
|
| 583 |
|
|
|
| 584 |
|
|
</div>
|
| 585 |
|
|
<a name="var$_has_error" id="$_has_error"><!-- --></A>
|
| 586 |
|
|
<div class="evenrow">
|
| 587 |
|
|
|
| 588 |
|
|
<div class="var-header">
|
| 589 |
|
|
<span class="var-title">
|
| 590 |
|
|
<span class="var-type">mixed</span>
|
| 591 |
|
|
<span class="var-name">$_has_error</span>
|
| 592 |
|
|
= <span class="var-default"> FALSE</span> (line <span class="line-number">78</span>)
|
| 593 |
|
|
</span>
|
| 594 |
|
|
</div>
|
| 595 |
|
|
|
| 596 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 597 |
|
|
<p class="short-description">Holds the state of the last validation</p>
|
| 598 |
|
|
<p class="description"><p>Sets to true in case of a validation error</p></p>
|
| 599 |
|
|
|
| 600 |
|
|
|
| 601 |
|
|
|
| 602 |
|
|
|
| 603 |
|
|
|
| 604 |
|
|
</div>
|
| 605 |
|
|
<a name="var$_has_form_on_submit" id="$_has_form_on_submit"><!-- --></A>
|
| 606 |
|
|
<div class="oddrow">
|
| 607 |
|
|
|
| 608 |
|
|
<div class="var-header">
|
| 609 |
|
|
<span class="var-title">
|
| 610 |
|
|
<span class="var-type">string</span>
|
| 611 |
|
|
<span class="var-name">$_has_form_on_submit</span>
|
| 612 |
|
|
= <span class="var-default"> false</span> (line <span class="line-number">127</span>)
|
| 613 |
|
|
</span>
|
| 614 |
|
|
</div>
|
| 615 |
|
|
|
| 616 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 617 |
|
|
<p class="short-description">This Form Element needs to propogate some js to the Form tag's onsubmit attribute</p>
|
| 618 |
|
|
|
| 619 |
|
|
|
| 620 |
|
|
|
| 621 |
|
|
<hr class="separator" />
|
| 622 |
|
|
<div class="notes">Redefined in descendants as:</div>
|
| 623 |
|
|
<ul class="redefinitions">
|
| 624 |
|
|
<li>
|
| 625 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEComboListBox.html#var$_has_form_on_submit">FEComboListBox::$_has_form_on_submit</a>
|
| 626 |
|
|
: This Form Element needs to propogate some js to the Form tag's onsubmit attribute
|
| 627 |
|
|
</li>
|
| 628 |
|
|
</ul>
|
| 629 |
|
|
|
| 630 |
|
|
|
| 631 |
|
|
</div>
|
| 632 |
|
|
<a name="var$_is_disabled" id="$_is_disabled"><!-- --></A>
|
| 633 |
|
|
<div class="evenrow">
|
| 634 |
|
|
|
| 635 |
|
|
<div class="var-header">
|
| 636 |
|
|
<span class="var-title">
|
| 637 |
|
|
<span class="var-type">mixed</span>
|
| 638 |
|
|
<span class="var-name">$_is_disabled</span>
|
| 639 |
|
|
= <span class="var-default"> FALSE</span> (line <span class="line-number">105</span>)
|
| 640 |
|
|
</span>
|
| 641 |
|
|
</div>
|
| 642 |
|
|
|
| 643 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 644 |
|
|
<p class="short-description">Indicates a disabled element</p>
|
| 645 |
|
|
|
| 646 |
|
|
|
| 647 |
|
|
|
| 648 |
|
|
|
| 649 |
|
|
|
| 650 |
|
|
</div>
|
| 651 |
|
|
<a name="var$_is_required" id="$_is_required"><!-- --></A>
|
| 652 |
|
|
<div class="oddrow">
|
| 653 |
|
|
|
| 654 |
|
|
<div class="var-header">
|
| 655 |
|
|
<span class="var-title">
|
| 656 |
|
|
<span class="var-type">mixed</span>
|
| 657 |
|
|
<span class="var-name">$_is_required</span>
|
| 658 |
|
|
= <span class="var-default"> TRUE</span> (line <span class="line-number">58</span>)
|
| 659 |
|
|
</span>
|
| 660 |
|
|
</div>
|
| 661 |
|
|
|
| 662 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 663 |
|
|
<p class="short-description">Indicates whether this elements</p>
|
| 664 |
|
|
<p class="description"><p>final value is required and cannot be empty</p></p>
|
| 665 |
|
|
|
| 666 |
|
|
|
| 667 |
|
|
|
| 668 |
|
|
|
| 669 |
|
|
|
| 670 |
|
|
</div>
|
| 671 |
|
|
<a name="var$_label_text" id="$_label_text"><!-- --></A>
|
| 672 |
|
|
<div class="evenrow">
|
| 673 |
|
|
|
| 674 |
|
|
<div class="var-header">
|
| 675 |
|
|
<span class="var-title">
|
| 676 |
|
|
<span class="var-type">mixed</span>
|
| 677 |
|
|
<span class="var-name">$_label_text</span>
|
| 678 |
|
|
= <span class="var-default"> NULL</span> (line <span class="line-number">45</span>)
|
| 679 |
|
|
</span>
|
| 680 |
|
|
</div>
|
| 681 |
|
|
|
| 682 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 683 |
|
|
<p class="short-description">Holds the elements label text</p>
|
| 684 |
|
|
|
| 685 |
|
|
|
| 686 |
|
|
|
| 687 |
|
|
|
| 688 |
|
|
|
| 689 |
|
|
</div>
|
| 690 |
|
|
<a name="var$_required_field_marker" id="$_required_field_marker"><!-- --></A>
|
| 691 |
|
|
<div class="oddrow">
|
| 692 |
|
|
|
| 693 |
|
|
<div class="var-header">
|
| 694 |
|
|
<span class="var-title">
|
| 695 |
|
|
<span class="var-type">mixed</span>
|
| 696 |
|
|
<span class="var-name">$_required_field_marker</span>
|
| 697 |
|
|
= <span class="var-default"> "*"</span> (line <span class="line-number">139</span>)
|
| 698 |
|
|
</span>
|
| 699 |
|
|
</div>
|
| 700 |
|
|
|
| 701 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 702 |
|
|
<p class="short-description">The required field string</p>
|
| 703 |
|
|
|
| 704 |
|
|
|
| 705 |
|
|
|
| 706 |
|
|
|
| 707 |
|
|
|
| 708 |
|
|
</div>
|
| 709 |
|
|
<a name="var$_slave_elements" id="$_slave_elements"><!-- --></A>
|
| 710 |
|
|
<div class="evenrow">
|
| 711 |
|
|
|
| 712 |
|
|
<div class="var-header">
|
| 713 |
|
|
<span class="var-title">
|
| 714 |
|
|
<span class="var-type">mixed</span>
|
| 715 |
|
|
<span class="var-name">$_slave_elements</span>
|
| 716 |
|
|
(line <span class="line-number">133</span>)
|
| 717 |
|
|
</span>
|
| 718 |
|
|
</div>
|
| 719 |
|
|
|
| 720 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 721 |
|
|
<p class="short-description">This holds an array of FormElement objects</p>
|
| 722 |
|
|
<p class="description"><p>that are slaves of this element</p></p>
|
| 723 |
|
|
|
| 724 |
|
|
|
| 725 |
|
|
|
| 726 |
|
|
|
| 727 |
|
|
|
| 728 |
|
|
</div>
|
| 729 |
|
|
<a name="var$_stripslashes" id="$_stripslashes"><!-- --></A>
|
| 730 |
|
|
<div class="oddrow">
|
| 731 |
|
|
|
| 732 |
|
|
<div class="var-header">
|
| 733 |
|
|
<span class="var-title">
|
| 734 |
|
|
<span class="var-type">mixed</span>
|
| 735 |
|
|
<span class="var-name">$_stripslashes</span>
|
| 736 |
|
|
= <span class="var-default"> FALSE</span> (line <span class="line-number">111</span>)
|
| 737 |
|
|
</span>
|
| 738 |
|
|
</div>
|
| 739 |
|
|
|
| 740 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 741 |
|
|
<p class="short-description">automatically strip slashes from</p>
|
| 742 |
|
|
<p class="description"><p>form values?</p></p>
|
| 743 |
|
|
|
| 744 |
|
|
|
| 745 |
|
|
|
| 746 |
|
|
|
| 747 |
|
|
|
| 748 |
|
|
</div>
|
| 749 |
|
|
<a name="var$_style_attributes" id="$_style_attributes"><!-- --></A>
|
| 750 |
|
|
<div class="evenrow">
|
| 751 |
|
|
|
| 752 |
|
|
<div class="var-header">
|
| 753 |
|
|
<span class="var-title">
|
| 754 |
|
|
<span class="var-type">mixed</span>
|
| 755 |
|
|
<span class="var-name">$_style_attributes</span>
|
| 756 |
|
|
(line <span class="line-number">99</span>)
|
| 757 |
|
|
</span>
|
| 758 |
|
|
</div>
|
| 759 |
|
|
|
| 760 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 761 |
|
|
<p class="short-description">Holds additional style attributes for</p>
|
| 762 |
|
|
<p class="description"><p>the elements html tag</p></p>
|
| 763 |
|
|
|
| 764 |
|
|
|
| 765 |
|
|
|
| 766 |
|
|
|
| 767 |
|
|
|
| 768 |
|
|
</div>
|
| 769 |
|
|
<a name="var$_value" id="$_value"><!-- --></A>
|
| 770 |
|
|
<div class="oddrow">
|
| 771 |
|
|
|
| 772 |
|
|
<div class="var-header">
|
| 773 |
|
|
<span class="var-title">
|
| 774 |
|
|
<span class="var-type">mixed</span>
|
| 775 |
|
|
<span class="var-name">$_value</span>
|
| 776 |
|
|
= <span class="var-default"> NULL</span> (line <span class="line-number">51</span>)
|
| 777 |
|
|
</span>
|
| 778 |
|
|
</div>
|
| 779 |
|
|
|
| 780 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 781 |
|
|
<p class="short-description">Holds the elements initial value</p>
|
| 782 |
|
|
|
| 783 |
|
|
|
| 784 |
|
|
|
| 785 |
|
|
|
| 786 |
|
|
|
| 787 |
|
|
</div>
|
| 788 |
|
|
|
| 789 |
|
|
</div>
|
| 790 |
|
|
</div>
|
| 791 |
|
|
|
| 792 |
|
|
<a name="sec-methods"></a>
|
| 793 |
|
|
<div class="info-box">
|
| 794 |
|
|
<div class="info-box-title">Methods</div>
|
| 795 |
|
|
<div class="nav-bar">
|
| 796 |
|
|
<a href="#sec-description">Description</a> |
|
| 797 |
|
|
<a href="#sec-descendents">Descendents</a> |
|
| 798 |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
| 799 |
|
|
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
| 800 |
|
|
|
| 801 |
|
|
</div>
|
| 802 |
|
|
<div class="info-box-body">
|
| 803 |
|
|
<A NAME='method_detail'></A>
|
| 804 |
|
|
<a name="methodFormElement" id="FormElement"><!-- --></a>
|
| 805 |
|
|
<div class="evenrow">
|
| 806 |
|
|
|
| 807 |
|
|
<div class="method-header">
|
| 808 |
|
|
<span class="method-title">Constructor FormElement</span> (line <span class="line-number">148</span>)
|
| 809 |
|
|
</div>
|
| 810 |
|
|
|
| 811 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 812 |
|
|
<p class="short-description">The constructor</p>
|
| 813 |
|
|
|
| 814 |
|
|
<div class="method-signature">
|
| 815 |
|
|
<span class="method-result">FormElement</span>
|
| 816 |
|
|
<span class="method-name">
|
| 817 |
|
|
FormElement
|
| 818 |
|
|
</span>
|
| 819 |
|
|
(<span class="var-type">label</span> <span class="var-name">$label</span>, [<span class="var-type">bool</span> <span class="var-name">$required</span> = <span class="var-default">TRUE</span>])
|
| 820 |
|
|
</div>
|
| 821 |
|
|
|
| 822 |
|
|
<ul class="parameters">
|
| 823 |
|
|
<li>
|
| 824 |
|
|
<span class="var-type">label</span>
|
| 825 |
|
|
<span class="var-name">$label</span><span class="var-description">: string - text label for the element</span> </li>
|
| 826 |
|
|
<li>
|
| 827 |
|
|
<span class="var-type">bool</span>
|
| 828 |
|
|
<span class="var-name">$required</span><span class="var-description">: required - is this a required element</span> </li>
|
| 829 |
|
|
</ul>
|
| 830 |
|
|
|
| 831 |
|
|
|
| 832 |
|
|
</div>
|
| 833 |
|
|
<a name="methodcreate_element_name" id="create_element_name"><!-- --></a>
|
| 834 |
|
|
<div class="oddrow">
|
| 835 |
|
|
|
| 836 |
|
|
<div class="method-header">
|
| 837 |
|
|
<span class="method-title">create_element_name</span> (line <span class="line-number">492</span>)
|
| 838 |
|
|
</div>
|
| 839 |
|
|
|
| 840 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 841 |
|
|
<p class="short-description">This function creates element name</p>
|
| 842 |
|
|
<p class="description"><p>used in the form based on the text label or any other parameters</p></p>
|
| 843 |
|
|
|
| 844 |
|
|
<div class="method-signature">
|
| 845 |
|
|
<span class="method-result">void</span>
|
| 846 |
|
|
<span class="method-name">
|
| 847 |
|
|
create_element_name
|
| 848 |
|
|
</span>
|
| 849 |
|
|
()
|
| 850 |
|
|
</div>
|
| 851 |
|
|
|
| 852 |
|
|
|
| 853 |
|
|
|
| 854 |
|
|
<hr class="separator" />
|
| 855 |
|
|
<div class="notes">Redefined in descendants as:</div>
|
| 856 |
|
|
<ul class="redefinitions">
|
| 857 |
|
|
<li>
|
| 858 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEMultiListBox.html#methodcreate_element_name">FEMultiListBox::create_element_name()</a>
|
| 859 |
|
|
: This function creates element name used in the form based on the text label or any other parameters
|
| 860 |
|
|
</li>
|
| 861 |
|
|
</ul>
|
| 862 |
|
|
</div>
|
| 863 |
|
|
<a name="methodform_tag_onsubmit" id="form_tag_onsubmit"><!-- --></a>
|
| 864 |
|
|
<div class="evenrow">
|
| 865 |
|
|
|
| 866 |
|
|
<div class="method-header">
|
| 867 |
|
|
<span class="method-title">form_tag_onsubmit</span> (line <span class="line-number">690</span>)
|
| 868 |
|
|
</div>
|
| 869 |
|
|
|
| 870 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 871 |
|
|
<p class="short-description">This is a method for getting the JS needed for the form tag's onsubmit attribute.</p>
|
| 872 |
|
|
|
| 873 |
|
|
<div class="method-signature">
|
| 874 |
|
|
<span class="method-result">string</span>
|
| 875 |
|
|
<span class="method-name">
|
| 876 |
|
|
form_tag_onsubmit
|
| 877 |
|
|
</span>
|
| 878 |
|
|
()
|
| 879 |
|
|
</div>
|
| 880 |
|
|
|
| 881 |
|
|
|
| 882 |
|
|
|
| 883 |
|
|
<hr class="separator" />
|
| 884 |
|
|
<div class="notes">Redefined in descendants as:</div>
|
| 885 |
|
|
<ul class="redefinitions">
|
| 886 |
|
|
<li>
|
| 887 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEComboListBox.html#methodform_tag_onsubmit">FEComboListBox::form_tag_onsubmit()</a>
|
| 888 |
|
|
: This is a method for getting the JS needed for the form tag's onsubmit attribute.
|
| 889 |
|
|
</li>
|
| 890 |
|
|
</ul>
|
| 891 |
|
|
</div>
|
| 892 |
|
|
<a name="methodget_attribute" id="get_attribute"><!-- --></a>
|
| 893 |
|
|
<div class="oddrow">
|
| 894 |
|
|
|
| 895 |
|
|
<div class="method-header">
|
| 896 |
|
|
<span class="method-title">get_attribute</span> (line <span class="line-number">373</span>)
|
| 897 |
|
|
</div>
|
| 898 |
|
|
|
| 899 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 900 |
|
|
<p class="short-description">return a single attribute</p>
|
| 901 |
|
|
<ul class="tags">
|
| 902 |
|
|
<li><span class="field">return:</span> the value</li>
|
| 903 |
|
|
</ul>
|
| 904 |
|
|
|
| 905 |
|
|
<div class="method-signature">
|
| 906 |
|
|
<span class="method-result">mixed</span>
|
| 907 |
|
|
<span class="method-name">
|
| 908 |
|
|
get_attribute
|
| 909 |
|
|
</span>
|
| 910 |
|
|
(<span class="var-type">string</span> <span class="var-name">$name</span>)
|
| 911 |
|
|
</div>
|
| 912 |
|
|
|
| 913 |
|
|
<ul class="parameters">
|
| 914 |
|
|
<li>
|
| 915 |
|
|
<span class="var-type">string</span>
|
| 916 |
|
|
<span class="var-name">$name</span><span class="var-description">: attribute name</span> </li>
|
| 917 |
|
|
</ul>
|
| 918 |
|
|
|
| 919 |
|
|
|
| 920 |
|
|
</div>
|
| 921 |
|
|
<a name="methodget_confirm_element" id="get_confirm_element"><!-- --></a>
|
| 922 |
|
|
<div class="evenrow">
|
| 923 |
|
|
|
| 924 |
|
|
<div class="method-header">
|
| 925 |
|
|
<span class="method-title">get_confirm_element</span> (line <span class="line-number">804</span>)
|
| 926 |
|
|
</div>
|
| 927 |
|
|
|
| 928 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 929 |
|
|
<p class="short-description">This method returns the hidden version of this element for a confirmation page.</p>
|
| 930 |
|
|
<p class="description"><p>NOTE: This is called by the FormProcessor only. It shouldn't be called manually.</p></p>
|
| 931 |
|
|
<ul class="tags">
|
| 932 |
|
|
<li><span class="field">return:</span> of type hidden</li>
|
| 933 |
|
|
</ul>
|
| 934 |
|
|
|
| 935 |
|
|
<div class="method-signature">
|
| 936 |
|
|
<span class="method-result"><a href="../../phpHtmlLib/INPUTtag.html">INPUTtag</a></span>
|
| 937 |
|
|
<span class="method-name">
|
| 938 |
|
|
get_confirm_element
|
| 939 |
|
|
</span>
|
| 940 |
|
|
()
|
| 941 |
|
|
</div>
|
| 942 |
|
|
|
| 943 |
|
|
|
| 944 |
|
|
|
| 945 |
|
|
<hr class="separator" />
|
| 946 |
|
|
<div class="notes">Redefined in descendants as:</div>
|
| 947 |
|
|
<ul class="redefinitions">
|
| 948 |
|
|
<li>
|
| 949 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEComboListBox.html#methodget_confirm_element">FEComboListBox::get_confirm_element()</a>
|
| 950 |
|
|
: This method returns the hidden version of this element for a confirmation page.
|
| 951 |
|
|
</li>
|
| 952 |
|
|
<li>
|
| 953 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEDate.html#methodget_confirm_element">FEDate::get_confirm_element()</a>
|
| 954 |
|
|
: This method returns the hidden version of this element for a confirmation page.
|
| 955 |
|
|
</li>
|
| 956 |
|
|
<li>
|
| 957 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEFile.html#methodget_confirm_element">FEFile::get_confirm_element()</a>
|
| 958 |
|
|
: This method returns the hidden version of this element for a confirmation page.
|
| 959 |
|
|
</li>
|
| 960 |
|
|
<li>
|
| 961 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEHidden.html#methodget_confirm_element">FEHidden::get_confirm_element()</a>
|
| 962 |
|
|
: This method returns the hidden version of this element for a confirmation page.
|
| 963 |
|
|
</li>
|
| 964 |
|
|
</ul>
|
| 965 |
|
|
</div>
|
| 966 |
|
|
<a name="methodget_element" id="get_element"><!-- --></a>
|
| 967 |
|
|
<div class="oddrow">
|
| 968 |
|
|
|
| 969 |
|
|
<div class="method-header">
|
| 970 |
|
|
<span class="method-title">get_element</span> (line <span class="line-number">787</span>)
|
| 971 |
|
|
</div>
|
| 972 |
|
|
|
| 973 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 974 |
|
|
<p class="short-description">This function builds and returns the form element object</p>
|
| 975 |
|
|
|
| 976 |
|
|
<div class="method-signature">
|
| 977 |
|
|
<span class="method-result">object</span>
|
| 978 |
|
|
<span class="method-name">
|
| 979 |
|
|
get_element
|
| 980 |
|
|
</span>
|
| 981 |
|
|
()
|
| 982 |
|
|
</div>
|
| 983 |
|
|
|
| 984 |
|
|
|
| 985 |
|
|
|
| 986 |
|
|
<hr class="separator" />
|
| 987 |
|
|
<div class="notes">Redefined in descendants as:</div>
|
| 988 |
|
|
<ul class="redefinitions">
|
| 989 |
|
|
<li>
|
| 990 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEButton.html#methodget_element">FEButton::get_element()</a>
|
| 991 |
|
|
: This function builds and returns the form element object
|
| 992 |
|
|
</li>
|
| 993 |
|
|
<li>
|
| 994 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FESubmitButton.html#methodget_element">FESubmitButton::get_element()</a>
|
| 995 |
|
|
: This function builds and returns the form element object
|
| 996 |
|
|
</li>
|
| 997 |
|
|
<li>
|
| 998 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEListBox.html#methodget_element">FEListBox::get_element()</a>
|
| 999 |
|
|
: This function builds and returns the form element object
|
| 1000 |
|
|
</li>
|
| 1001 |
|
|
<li>
|
| 1002 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEMultiListBox.html#methodget_element">FEMultiListBox::get_element()</a>
|
| 1003 |
|
|
: This function builds and returns the form element object
|
| 1004 |
|
|
</li>
|
| 1005 |
|
|
<li>
|
| 1006 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FECheckBoxList.html#methodget_element">FECheckBoxList::get_element()</a>
|
| 1007 |
|
|
: This function builds and returns the form element object
|
| 1008 |
|
|
</li>
|
| 1009 |
|
|
<li>
|
| 1010 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FENestedListBox.html#methodget_element">FENestedListBox::get_element()</a>
|
| 1011 |
|
|
: This function builds and returns the form element object
|
| 1012 |
|
|
</li>
|
| 1013 |
|
|
<li>
|
| 1014 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEComboListBox.html#methodget_element">FEComboListBox::get_element()</a>
|
| 1015 |
|
|
: This function builds and returns the form element object
|
| 1016 |
|
|
</li>
|
| 1017 |
|
|
<li>
|
| 1018 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEDate.html#methodget_element">FEDate::get_element()</a>
|
| 1019 |
|
|
: This function builds and returns the form element object
|
| 1020 |
|
|
</li>
|
| 1021 |
|
|
<li>
|
| 1022 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FETextArea.html#methodget_element">FETextArea::get_element()</a>
|
| 1023 |
|
|
: This function builds and returns the form element object
|
| 1024 |
|
|
</li>
|
| 1025 |
|
|
<li>
|
| 1026 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FECheckBox.html#methodget_element">FECheckBox::get_element()</a>
|
| 1027 |
|
|
: This function builds and returns the form element object
|
| 1028 |
|
|
</li>
|
| 1029 |
|
|
<li>
|
| 1030 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FERadioGroup.html#methodget_element">FERadioGroup::get_element()</a>
|
| 1031 |
|
|
: This function builds and returns the form element object
|
| 1032 |
|
|
</li>
|
| 1033 |
|
|
<li>
|
| 1034 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEText.html#methodget_element">FEText::get_element()</a>
|
| 1035 |
|
|
: This function builds and returns the form element object
|
| 1036 |
|
|
</li>
|
| 1037 |
|
|
<li>
|
| 1038 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEFile.html#methodget_element">FEFile::get_element()</a>
|
| 1039 |
|
|
: This function builds and returns the form element object
|
| 1040 |
|
|
</li>
|
| 1041 |
|
|
<li>
|
| 1042 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEPassword.html#methodget_element">FEPassword::get_element()</a>
|
| 1043 |
|
|
: This function builds and returns the form element object
|
| 1044 |
|
|
</li>
|
| 1045 |
|
|
<li>
|
| 1046 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEHostNameWithPort.html#methodget_element">FEHostNameWithPort::get_element()</a>
|
| 1047 |
|
|
: This function builds and returns the form element object
|
| 1048 |
|
|
</li>
|
| 1049 |
|
|
<li>
|
| 1050 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEHidden.html#methodget_element">FEHidden::get_element()</a>
|
| 1051 |
|
|
</li>
|
| 1052 |
|
|
</ul>
|
| 1053 |
|
|
</div>
|
| 1054 |
|
|
<a name="methodget_element_name" id="get_element_name"><!-- --></a>
|
| 1055 |
|
|
<div class="evenrow">
|
| 1056 |
|
|
|
| 1057 |
|
|
<div class="method-header">
|
| 1058 |
|
|
<span class="method-title">get_element_name</span> (line <span class="line-number">524</span>)
|
| 1059 |
|
|
</div>
|
| 1060 |
|
|
|
| 1061 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1062 |
|
|
<p class="short-description">Returns the element name to be used in the form</p>
|
| 1063 |
|
|
<ul class="tags">
|
| 1064 |
|
|
<li><span class="field">return:</span> form element name</li>
|
| 1065 |
|
|
</ul>
|
| 1066 |
|
|
|
| 1067 |
|
|
<div class="method-signature">
|
| 1068 |
|
|
<span class="method-result">string</span>
|
| 1069 |
|
|
<span class="method-name">
|
| 1070 |
|
|
get_element_name
|
| 1071 |
|
|
</span>
|
| 1072 |
|
|
()
|
| 1073 |
|
|
</div>
|
| 1074 |
|
|
|
| 1075 |
|
|
|
| 1076 |
|
|
|
| 1077 |
|
|
</div>
|
| 1078 |
|
|
<a name="methodget_errors" id="get_errors"><!-- --></a>
|
| 1079 |
|
|
<div class="oddrow">
|
| 1080 |
|
|
|
| 1081 |
|
|
<div class="method-header">
|
| 1082 |
|
|
<span class="method-title">get_errors</span> (line <span class="line-number">447</span>)
|
| 1083 |
|
|
</div>
|
| 1084 |
|
|
|
| 1085 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1086 |
|
|
<p class="short-description">This returns the array of errors for this element</p>
|
| 1087 |
|
|
|
| 1088 |
|
|
<div class="method-signature">
|
| 1089 |
|
|
<span class="method-result">void</span>
|
| 1090 |
|
|
<span class="method-name">
|
| 1091 |
|
|
get_errors
|
| 1092 |
|
|
</span>
|
| 1093 |
|
|
(<span class="var-type">array</span> <span class="var-name">0</span>)
|
| 1094 |
|
|
</div>
|
| 1095 |
|
|
|
| 1096 |
|
|
<ul class="parameters">
|
| 1097 |
|
|
<li>
|
| 1098 |
|
|
<span class="var-type">array</span>
|
| 1099 |
|
|
<span class="var-name">0</span><span class="var-description">: of errors</span> </li>
|
| 1100 |
|
|
</ul>
|
| 1101 |
|
|
|
| 1102 |
|
|
|
| 1103 |
|
|
</div>
|
| 1104 |
|
|
<a name="methodget_error_message" id="get_error_message"><!-- --></a>
|
| 1105 |
|
|
<div class="evenrow">
|
| 1106 |
|
|
|
| 1107 |
|
|
<div class="method-header">
|
| 1108 |
|
|
<span class="method-title">get_error_message</span> (line <span class="line-number">458</span>)
|
| 1109 |
|
|
</div>
|
| 1110 |
|
|
|
| 1111 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1112 |
|
|
<p class="short-description">Returns the current error message if any</p>
|
| 1113 |
|
|
<ul class="tags">
|
| 1114 |
|
|
<li><span class="field">return:</span> text - error message</li>
|
| 1115 |
|
|
</ul>
|
| 1116 |
|
|
|
| 1117 |
|
|
<div class="method-signature">
|
| 1118 |
|
|
<span class="method-result">mesage</span>
|
| 1119 |
|
|
<span class="method-name">
|
| 1120 |
|
|
get_error_message
|
| 1121 |
|
|
</span>
|
| 1122 |
|
|
()
|
| 1123 |
|
|
</div>
|
| 1124 |
|
|
|
| 1125 |
|
|
|
| 1126 |
|
|
|
| 1127 |
|
|
</div>
|
| 1128 |
|
|
<a name="methodget_init_value" id="get_init_value"><!-- --></a>
|
| 1129 |
|
|
<div class="oddrow">
|
| 1130 |
|
|
|
| 1131 |
|
|
<div class="method-header">
|
| 1132 |
|
|
<span class="method-title">get_init_value</span> (line <span class="line-number">312</span>)
|
| 1133 |
|
|
</div>
|
| 1134 |
|
|
|
| 1135 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1136 |
|
|
<p class="short-description">This returns the initial value of the element</p>
|
| 1137 |
|
|
|
| 1138 |
|
|
<div class="method-signature">
|
| 1139 |
|
|
<span class="method-result">mixed</span>
|
| 1140 |
|
|
<span class="method-name">
|
| 1141 |
|
|
get_init_value
|
| 1142 |
|
|
</span>
|
| 1143 |
|
|
()
|
| 1144 |
|
|
</div>
|
| 1145 |
|
|
|
| 1146 |
|
|
|
| 1147 |
|
|
|
| 1148 |
|
|
</div>
|
| 1149 |
|
|
<a name="methodget_label" id="get_label"><!-- --></a>
|
| 1150 |
|
|
<div class="evenrow">
|
| 1151 |
|
|
|
| 1152 |
|
|
<div class="method-header">
|
| 1153 |
|
|
<span class="method-title">get_label</span> (line <span class="line-number">761</span>)
|
| 1154 |
|
|
</div>
|
| 1155 |
|
|
|
| 1156 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1157 |
|
|
<p class="short-description">This function builds and returns a label object based on the label text and error conditions</p>
|
| 1158 |
|
|
|
| 1159 |
|
|
<div class="method-signature">
|
| 1160 |
|
|
<span class="method-result"><a href="../../phpHtmlLib/SPANtag.html">object SPANtag</a></span>
|
| 1161 |
|
|
<span class="method-name">
|
| 1162 |
|
|
get_label
|
| 1163 |
|
|
</span>
|
| 1164 |
|
|
([<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormContent.html">FormContent</a></span> <span class="var-name">$form_content</span> = <span class="var-default">NULL</span>])
|
| 1165 |
|
|
</div>
|
| 1166 |
|
|
|
| 1167 |
|
|
<ul class="parameters">
|
| 1168 |
|
|
<li>
|
| 1169 |
|
|
<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormContent.html">FormContent</a></span>
|
| 1170 |
|
|
<span class="var-name">$form_content</span><span class="var-description">: object that holds the required field marker</span> </li>
|
| 1171 |
|
|
</ul>
|
| 1172 |
|
|
|
| 1173 |
|
|
|
| 1174 |
|
|
<hr class="separator" />
|
| 1175 |
|
|
<div class="notes">Redefined in descendants as:</div>
|
| 1176 |
|
|
<ul class="redefinitions">
|
| 1177 |
|
|
<li>
|
| 1178 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FENumberInRange.html#methodget_label">FENumberInRange::get_label()</a>
|
| 1179 |
|
|
</li>
|
| 1180 |
|
|
</ul>
|
| 1181 |
|
|
</div>
|
| 1182 |
|
|
<a name="methodget_label_text" id="get_label_text"><!-- --></a>
|
| 1183 |
|
|
<div class="oddrow">
|
| 1184 |
|
|
|
| 1185 |
|
|
<div class="method-header">
|
| 1186 |
|
|
<span class="method-title">get_label_text</span> (line <span class="line-number">199</span>)
|
| 1187 |
|
|
</div>
|
| 1188 |
|
|
|
| 1189 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1190 |
|
|
<p class="short-description">This function will return the elements label text</p>
|
| 1191 |
|
|
|
| 1192 |
|
|
<div class="method-signature">
|
| 1193 |
|
|
<span class="method-result">string</span>
|
| 1194 |
|
|
<span class="method-name">
|
| 1195 |
|
|
get_label_text
|
| 1196 |
|
|
</span>
|
| 1197 |
|
|
()
|
| 1198 |
|
|
</div>
|
| 1199 |
|
|
|
| 1200 |
|
|
|
| 1201 |
|
|
|
| 1202 |
|
|
</div>
|
| 1203 |
|
|
<a name="methodget_required_symbol" id="get_required_symbol"><!-- --></a>
|
| 1204 |
|
|
<div class="evenrow">
|
| 1205 |
|
|
|
| 1206 |
|
|
<div class="method-header">
|
| 1207 |
|
|
<span class="method-title">get_required_symbol</span> (line <span class="line-number">704</span>)
|
| 1208 |
|
|
</div>
|
| 1209 |
|
|
|
| 1210 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1211 |
|
|
<p class="short-description">This function return the symbol used to denote a required field</p>
|
| 1212 |
|
|
<ul class="tags">
|
| 1213 |
|
|
<li><span class="field">return:</span> - required symbol</li>
|
| 1214 |
|
|
</ul>
|
| 1215 |
|
|
|
| 1216 |
|
|
<div class="method-signature">
|
| 1217 |
|
|
<span class="method-result">string</span>
|
| 1218 |
|
|
<span class="method-name">
|
| 1219 |
|
|
get_required_symbol
|
| 1220 |
|
|
</span>
|
| 1221 |
|
|
()
|
| 1222 |
|
|
</div>
|
| 1223 |
|
|
|
| 1224 |
|
|
|
| 1225 |
|
|
|
| 1226 |
|
|
</div>
|
| 1227 |
|
|
<a name="methodget_slave_elements" id="get_slave_elements"><!-- --></a>
|
| 1228 |
|
|
<div class="oddrow">
|
| 1229 |
|
|
|
| 1230 |
|
|
<div class="method-header">
|
| 1231 |
|
|
<span class="method-title">get_slave_elements</span> (line <span class="line-number">166</span>)
|
| 1232 |
|
|
</div>
|
| 1233 |
|
|
|
| 1234 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1235 |
|
|
<p class="short-description">This function will return the slaves of this element</p>
|
| 1236 |
|
|
<ul class="tags">
|
| 1237 |
|
|
<li><span class="field">return:</span> of slave elements</li>
|
| 1238 |
|
|
</ul>
|
| 1239 |
|
|
|
| 1240 |
|
|
<div class="method-signature">
|
| 1241 |
|
|
<span class="method-result">array</span>
|
| 1242 |
|
|
<span class="method-name">
|
| 1243 |
|
|
&get_slave_elements
|
| 1244 |
|
|
</span>
|
| 1245 |
|
|
()
|
| 1246 |
|
|
</div>
|
| 1247 |
|
|
|
| 1248 |
|
|
|
| 1249 |
|
|
|
| 1250 |
|
|
</div>
|
| 1251 |
|
|
<a name="methodget_tabindex" id="get_tabindex"><!-- --></a>
|
| 1252 |
|
|
<div class="evenrow">
|
| 1253 |
|
|
|
| 1254 |
|
|
<div class="method-header">
|
| 1255 |
|
|
<span class="method-title">get_tabindex</span> (line <span class="line-number">410</span>)
|
| 1256 |
|
|
</div>
|
| 1257 |
|
|
|
| 1258 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1259 |
|
|
<p class="short-description">Gets the current tab index if any</p>
|
| 1260 |
|
|
<ul class="tags">
|
| 1261 |
|
|
<li><span class="field">return:</span> returns 0 if there is none set.</li>
|
| 1262 |
|
|
</ul>
|
| 1263 |
|
|
|
| 1264 |
|
|
<div class="method-signature">
|
| 1265 |
|
|
<span class="method-result">int</span>
|
| 1266 |
|
|
<span class="method-name">
|
| 1267 |
|
|
get_tabindex
|
| 1268 |
|
|
</span>
|
| 1269 |
|
|
()
|
| 1270 |
|
|
</div>
|
| 1271 |
|
|
|
| 1272 |
|
|
|
| 1273 |
|
|
|
| 1274 |
|
|
</div>
|
| 1275 |
|
|
<a name="methodget_value" id="get_value"><!-- --></a>
|
| 1276 |
|
|
<div class="oddrow">
|
| 1277 |
|
|
|
| 1278 |
|
|
<div class="method-header">
|
| 1279 |
|
|
<span class="method-title">get_value</span> (line <span class="line-number">219</span>)
|
| 1280 |
|
|
</div>
|
| 1281 |
|
|
|
| 1282 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1283 |
|
|
<p class="short-description">This function will return the elements value</p>
|
| 1284 |
|
|
|
| 1285 |
|
|
<div class="method-signature">
|
| 1286 |
|
|
<span class="method-result">mixed</span>
|
| 1287 |
|
|
<span class="method-name">
|
| 1288 |
|
|
get_value
|
| 1289 |
|
|
</span>
|
| 1290 |
|
|
()
|
| 1291 |
|
|
</div>
|
| 1292 |
|
|
|
| 1293 |
|
|
|
| 1294 |
|
|
|
| 1295 |
|
|
<hr class="separator" />
|
| 1296 |
|
|
<div class="notes">Redefined in descendants as:</div>
|
| 1297 |
|
|
<ul class="redefinitions">
|
| 1298 |
|
|
<li>
|
| 1299 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEComboListBox.html#methodget_value">FEComboListBox::get_value()</a>
|
| 1300 |
|
|
: This function will return the elements value
|
| 1301 |
|
|
</li>
|
| 1302 |
|
|
<li>
|
| 1303 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEDate.html#methodget_value">FEDate::get_value()</a>
|
| 1304 |
|
|
: This function will return the elements value as an array or month, day and year
|
| 1305 |
|
|
</li>
|
| 1306 |
|
|
<li>
|
| 1307 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEFile.html#methodget_value">FEFile::get_value()</a>
|
| 1308 |
|
|
: This function will return the elements value
|
| 1309 |
|
|
</li>
|
| 1310 |
|
|
</ul>
|
| 1311 |
|
|
</div>
|
| 1312 |
|
|
<a name="methodget_value_text" id="get_value_text"><!-- --></a>
|
| 1313 |
|
|
<div class="evenrow">
|
| 1314 |
|
|
|
| 1315 |
|
|
<div class="method-header">
|
| 1316 |
|
|
<span class="method-title">get_value_text</span> (line <span class="line-number">280</span>)
|
| 1317 |
|
|
</div>
|
| 1318 |
|
|
|
| 1319 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1320 |
|
|
<p class="short-description">This provides a method</p>
|
| 1321 |
|
|
<p class="description"><p>for the FormContent to get access to the text associated with a field. This is only available on FormElements that have text associated with a field. It is used during Confirmation</p></p>
|
| 1322 |
|
|
<ul class="tags">
|
| 1323 |
|
|
<li><span class="field">return:</span> - the text associated</li>
|
| 1324 |
|
|
</ul>
|
| 1325 |
|
|
|
| 1326 |
|
|
<div class="method-signature">
|
| 1327 |
|
|
<span class="method-result">string</span>
|
| 1328 |
|
|
<span class="method-name">
|
| 1329 |
|
|
get_value_text
|
| 1330 |
|
|
</span>
|
| 1331 |
|
|
(<span class="var-type">mixed</span> <span class="var-name">0</span>)
|
| 1332 |
|
|
</div>
|
| 1333 |
|
|
|
| 1334 |
|
|
<ul class="parameters">
|
| 1335 |
|
|
<li>
|
| 1336 |
|
|
<span class="var-type">mixed</span>
|
| 1337 |
|
|
<span class="var-name">0</span><span class="var-description">: the value to look up</span> </li>
|
| 1338 |
|
|
</ul>
|
| 1339 |
|
|
|
| 1340 |
|
|
|
| 1341 |
|
|
<hr class="separator" />
|
| 1342 |
|
|
<div class="notes">Redefined in descendants as:</div>
|
| 1343 |
|
|
<ul class="redefinitions">
|
| 1344 |
|
|
<li>
|
| 1345 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methodget_value_text">FEDataList::get_value_text()</a>
|
| 1346 |
|
|
: This provides a method
|
| 1347 |
|
|
</li>
|
| 1348 |
|
|
<li>
|
| 1349 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEMultiListBox.html#methodget_value_text">FEMultiListBox::get_value_text()</a>
|
| 1350 |
|
|
: build the string for the confirmation page
|
| 1351 |
|
|
</li>
|
| 1352 |
|
|
<li>
|
| 1353 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FENestedListBox.html#methodget_value_text">FENestedListBox::get_value_text()</a>
|
| 1354 |
|
|
: This provides a method
|
| 1355 |
|
|
</li>
|
| 1356 |
|
|
<li>
|
| 1357 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEComboListBox.html#methodget_value_text">FEComboListBox::get_value_text()</a>
|
| 1358 |
|
|
: This provides a method
|
| 1359 |
|
|
</li>
|
| 1360 |
|
|
<li>
|
| 1361 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEDate.html#methodget_value_text">FEDate::get_value_text()</a>
|
| 1362 |
|
|
: This returns a formatted string used for the confirmation display (and possibly elsewhere)
|
| 1363 |
|
|
</li>
|
| 1364 |
|
|
<li>
|
| 1365 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FECheckBox.html#methodget_value_text">FECheckBox::get_value_text()</a>
|
| 1366 |
|
|
: This provides a method
|
| 1367 |
|
|
</li>
|
| 1368 |
|
|
<li>
|
| 1369 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FERadioGroup.html#methodget_value_text">FERadioGroup::get_value_text()</a>
|
| 1370 |
|
|
: This provides a method
|
| 1371 |
|
|
</li>
|
| 1372 |
|
|
<li>
|
| 1373 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEFile.html#methodget_value_text">FEFile::get_value_text()</a>
|
| 1374 |
|
|
</li>
|
| 1375 |
|
|
</ul>
|
| 1376 |
|
|
</div>
|
| 1377 |
|
|
<a name="methodhas_error" id="has_error"><!-- --></a>
|
| 1378 |
|
|
<div class="oddrow">
|
| 1379 |
|
|
|
| 1380 |
|
|
<div class="method-header">
|
| 1381 |
|
|
<span class="method-title">has_error</span> (line <span class="line-number">468</span>)
|
| 1382 |
|
|
</div>
|
| 1383 |
|
|
|
| 1384 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1385 |
|
|
<p class="short-description">Returns the current error state</p>
|
| 1386 |
|
|
<ul class="tags">
|
| 1387 |
|
|
<li><span class="field">return:</span> error state</li>
|
| 1388 |
|
|
</ul>
|
| 1389 |
|
|
|
| 1390 |
|
|
<div class="method-signature">
|
| 1391 |
|
|
<span class="method-result">bool</span>
|
| 1392 |
|
|
<span class="method-name">
|
| 1393 |
|
|
has_error
|
| 1394 |
|
|
</span>
|
| 1395 |
|
|
([<span class="var-type">mixed</span> <span class="var-name">$label</span> = <span class="var-default">NULL</span>])
|
| 1396 |
|
|
</div>
|
| 1397 |
|
|
|
| 1398 |
|
|
|
| 1399 |
|
|
|
| 1400 |
|
|
</div>
|
| 1401 |
|
|
<a name="methodis_disabled" id="is_disabled"><!-- --></a>
|
| 1402 |
|
|
<div class="evenrow">
|
| 1403 |
|
|
|
| 1404 |
|
|
<div class="method-header">
|
| 1405 |
|
|
<span class="method-title">is_disabled</span> (line <span class="line-number">332</span>)
|
| 1406 |
|
|
</div>
|
| 1407 |
|
|
|
| 1408 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1409 |
|
|
<p class="short-description">Returns the elements disabled state</p>
|
| 1410 |
|
|
<ul class="tags">
|
| 1411 |
|
|
<li><span class="field">return:</span> disabled</li>
|
| 1412 |
|
|
</ul>
|
| 1413 |
|
|
|
| 1414 |
|
|
<div class="method-signature">
|
| 1415 |
|
|
<span class="method-result">bool</span>
|
| 1416 |
|
|
<span class="method-name">
|
| 1417 |
|
|
is_disabled
|
| 1418 |
|
|
</span>
|
| 1419 |
|
|
()
|
| 1420 |
|
|
</div>
|
| 1421 |
|
|
|
| 1422 |
|
|
|
| 1423 |
|
|
|
| 1424 |
|
|
</div>
|
| 1425 |
|
|
<a name="methodis_required" id="is_required"><!-- --></a>
|
| 1426 |
|
|
<div class="oddrow">
|
| 1427 |
|
|
|
| 1428 |
|
|
<div class="method-header">
|
| 1429 |
|
|
<span class="method-title">is_required</span> (line <span class="line-number">301</span>)
|
| 1430 |
|
|
</div>
|
| 1431 |
|
|
|
| 1432 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1433 |
|
|
<p class="short-description">Returns whether this elements final value cannot be empty</p>
|
| 1434 |
|
|
<ul class="tags">
|
| 1435 |
|
|
<li><span class="field">return:</span> requried</li>
|
| 1436 |
|
|
</ul>
|
| 1437 |
|
|
|
| 1438 |
|
|
<div class="method-signature">
|
| 1439 |
|
|
<span class="method-result">bool</span>
|
| 1440 |
|
|
<span class="method-name">
|
| 1441 |
|
|
is_required
|
| 1442 |
|
|
</span>
|
| 1443 |
|
|
()
|
| 1444 |
|
|
</div>
|
| 1445 |
|
|
|
| 1446 |
|
|
|
| 1447 |
|
|
|
| 1448 |
|
|
</div>
|
| 1449 |
|
|
<a name="methodjavascript" id="javascript"><!-- --></a>
|
| 1450 |
|
|
<div class="evenrow">
|
| 1451 |
|
|
|
| 1452 |
|
|
<div class="method-header">
|
| 1453 |
|
|
<span class="method-title">javascript</span> (line <span class="line-number">590</span>)
|
| 1454 |
|
|
</div>
|
| 1455 |
|
|
|
| 1456 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1457 |
|
|
<p class="short-description">This method is used for adding any javascript that is used by this element. This will automatically get called and added to the page by the FormProcessor</p>
|
| 1458 |
|
|
<ul class="tags">
|
| 1459 |
|
|
<li><span class="field">return:</span> - raw js</li>
|
| 1460 |
|
|
</ul>
|
| 1461 |
|
|
|
| 1462 |
|
|
<div class="method-signature">
|
| 1463 |
|
|
<span class="method-result">string</span>
|
| 1464 |
|
|
<span class="method-name">
|
| 1465 |
|
|
javascript
|
| 1466 |
|
|
</span>
|
| 1467 |
|
|
()
|
| 1468 |
|
|
</div>
|
| 1469 |
|
|
|
| 1470 |
|
|
|
| 1471 |
|
|
|
| 1472 |
|
|
<hr class="separator" />
|
| 1473 |
|
|
<div class="notes">Redefined in descendants as:</div>
|
| 1474 |
|
|
<ul class="redefinitions">
|
| 1475 |
|
|
<li>
|
| 1476 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEListBoxMaster.html#methodjavascript">FEListBoxMaster::javascript()</a>
|
| 1477 |
|
|
: This method is used for adding any javascript that is used by this element. This will automatically get called and added to the page by the FormProcessor
|
| 1478 |
|
|
</li>
|
| 1479 |
|
|
<li>
|
| 1480 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEComboListBox.html#methodjavascript">FEComboListBox::javascript()</a>
|
| 1481 |
|
|
: This method builds the Javascript needed for this element.
|
| 1482 |
|
|
</li>
|
| 1483 |
|
|
</ul>
|
| 1484 |
|
|
</div>
|
| 1485 |
|
|
<a name="methodonBlur" id="onBlur"><!-- --></a>
|
| 1486 |
|
|
<div class="oddrow">
|
| 1487 |
|
|
|
| 1488 |
|
|
<div class="method-header">
|
| 1489 |
|
|
<span class="method-title">onBlur</span> (line <span class="line-number">630</span>)
|
| 1490 |
|
|
</div>
|
| 1491 |
|
|
|
| 1492 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1493 |
|
|
<p class="short-description">This function return the javaScript code for an onBlur event</p>
|
| 1494 |
|
|
<ul class="tags">
|
| 1495 |
|
|
<li><span class="field">return:</span> - javascript code</li>
|
| 1496 |
|
|
</ul>
|
| 1497 |
|
|
|
| 1498 |
|
|
<div class="method-signature">
|
| 1499 |
|
|
<span class="method-result">string</span>
|
| 1500 |
|
|
<span class="method-name">
|
| 1501 |
|
|
onBlur
|
| 1502 |
|
|
</span>
|
| 1503 |
|
|
()
|
| 1504 |
|
|
</div>
|
| 1505 |
|
|
|
| 1506 |
|
|
|
| 1507 |
|
|
|
| 1508 |
|
|
</div>
|
| 1509 |
|
|
<a name="methodonChange" id="onChange"><!-- --></a>
|
| 1510 |
|
|
<div class="evenrow">
|
| 1511 |
|
|
|
| 1512 |
|
|
<div class="method-header">
|
| 1513 |
|
|
<span class="method-title">onChange</span> (line <span class="line-number">641</span>)
|
| 1514 |
|
|
</div>
|
| 1515 |
|
|
|
| 1516 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1517 |
|
|
<p class="short-description">this function retuns the javaScript code for an onChange event</p>
|
| 1518 |
|
|
<ul class="tags">
|
| 1519 |
|
|
<li><span class="field">return:</span> - javascript code</li>
|
| 1520 |
|
|
</ul>
|
| 1521 |
|
|
|
| 1522 |
|
|
<div class="method-signature">
|
| 1523 |
|
|
<span class="method-result">string</span>
|
| 1524 |
|
|
<span class="method-name">
|
| 1525 |
|
|
onChange
|
| 1526 |
|
|
</span>
|
| 1527 |
|
|
()
|
| 1528 |
|
|
</div>
|
| 1529 |
|
|
|
| 1530 |
|
|
|
| 1531 |
|
|
|
| 1532 |
|
|
<hr class="separator" />
|
| 1533 |
|
|
<div class="notes">Redefined in descendants as:</div>
|
| 1534 |
|
|
<ul class="redefinitions">
|
| 1535 |
|
|
<li>
|
| 1536 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEListBoxMaster.html#methodonChange">FEListBoxMaster::onChange()</a>
|
| 1537 |
|
|
: this function retuns the javaScript code for an onChange event
|
| 1538 |
|
|
</li>
|
| 1539 |
|
|
</ul>
|
| 1540 |
|
|
</div>
|
| 1541 |
|
|
<a name="methodonClick" id="onClick"><!-- --></a>
|
| 1542 |
|
|
<div class="oddrow">
|
| 1543 |
|
|
|
| 1544 |
|
|
<div class="method-header">
|
| 1545 |
|
|
<span class="method-title">onClick</span> (line <span class="line-number">600</span>)
|
| 1546 |
|
|
</div>
|
| 1547 |
|
|
|
| 1548 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1549 |
|
|
<p class="short-description">This function return the javaScript code for an onClick event</p>
|
| 1550 |
|
|
<ul class="tags">
|
| 1551 |
|
|
<li><span class="field">return:</span> - javascript code</li>
|
| 1552 |
|
|
</ul>
|
| 1553 |
|
|
|
| 1554 |
|
|
<div class="method-signature">
|
| 1555 |
|
|
<span class="method-result">string</span>
|
| 1556 |
|
|
<span class="method-name">
|
| 1557 |
|
|
onClick
|
| 1558 |
|
|
</span>
|
| 1559 |
|
|
()
|
| 1560 |
|
|
</div>
|
| 1561 |
|
|
|
| 1562 |
|
|
|
| 1563 |
|
|
|
| 1564 |
|
|
<hr class="separator" />
|
| 1565 |
|
|
<div class="notes">Redefined in descendants as:</div>
|
| 1566 |
|
|
<ul class="redefinitions">
|
| 1567 |
|
|
<li>
|
| 1568 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEButton.html#methodonClick">FEButton::onClick()</a>
|
| 1569 |
|
|
: This function return the javaScript code for an onClick event
|
| 1570 |
|
|
</li>
|
| 1571 |
|
|
<li>
|
| 1572 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FESubmitButton.html#methodonClick">FESubmitButton::onClick()</a>
|
| 1573 |
|
|
: This function return the javaScript code for an onSubmit event
|
| 1574 |
|
|
</li>
|
| 1575 |
|
|
</ul>
|
| 1576 |
|
|
</div>
|
| 1577 |
|
|
<a name="methodonFocus" id="onFocus"><!-- --></a>
|
| 1578 |
|
|
<div class="evenrow">
|
| 1579 |
|
|
|
| 1580 |
|
|
<div class="method-header">
|
| 1581 |
|
|
<span class="method-title">onFocus</span> (line <span class="line-number">610</span>)
|
| 1582 |
|
|
</div>
|
| 1583 |
|
|
|
| 1584 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1585 |
|
|
<p class="short-description">This function return the javaScript code for an onFocus event</p>
|
| 1586 |
|
|
<ul class="tags">
|
| 1587 |
|
|
<li><span class="field">return:</span> - javascript code</li>
|
| 1588 |
|
|
</ul>
|
| 1589 |
|
|
|
| 1590 |
|
|
<div class="method-signature">
|
| 1591 |
|
|
<span class="method-result">string</span>
|
| 1592 |
|
|
<span class="method-name">
|
| 1593 |
|
|
onFocus
|
| 1594 |
|
|
</span>
|
| 1595 |
|
|
()
|
| 1596 |
|
|
</div>
|
| 1597 |
|
|
|
| 1598 |
|
|
|
| 1599 |
|
|
|
| 1600 |
|
|
</div>
|
| 1601 |
|
|
<a name="methodonSubmit" id="onSubmit"><!-- --></a>
|
| 1602 |
|
|
<div class="oddrow">
|
| 1603 |
|
|
|
| 1604 |
|
|
<div class="method-header">
|
| 1605 |
|
|
<span class="method-title">onSubmit</span> (line <span class="line-number">620</span>)
|
| 1606 |
|
|
</div>
|
| 1607 |
|
|
|
| 1608 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1609 |
|
|
<p class="short-description">This function return the javaScript code for an onSubmit event</p>
|
| 1610 |
|
|
<ul class="tags">
|
| 1611 |
|
|
<li><span class="field">return:</span> - javascript code</li>
|
| 1612 |
|
|
</ul>
|
| 1613 |
|
|
|
| 1614 |
|
|
<div class="method-signature">
|
| 1615 |
|
|
<span class="method-result">string</span>
|
| 1616 |
|
|
<span class="method-name">
|
| 1617 |
|
|
onSubmit
|
| 1618 |
|
|
</span>
|
| 1619 |
|
|
()
|
| 1620 |
|
|
</div>
|
| 1621 |
|
|
|
| 1622 |
|
|
|
| 1623 |
|
|
|
| 1624 |
|
|
</div>
|
| 1625 |
|
|
<a name="methodset_attribute" id="set_attribute"><!-- --></a>
|
| 1626 |
|
|
<div class="evenrow">
|
| 1627 |
|
|
|
| 1628 |
|
|
<div class="method-header">
|
| 1629 |
|
|
<span class="method-title">set_attribute</span> (line <span class="line-number">357</span>)
|
| 1630 |
|
|
</div>
|
| 1631 |
|
|
|
| 1632 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1633 |
|
|
<p class="short-description">add a single attribute (name="value")</p>
|
| 1634 |
|
|
|
| 1635 |
|
|
<div class="method-signature">
|
| 1636 |
|
|
<span class="method-result">void</span>
|
| 1637 |
|
|
<span class="method-name">
|
| 1638 |
|
|
set_attribute
|
| 1639 |
|
|
</span>
|
| 1640 |
|
|
(<span class="var-type">string</span> <span class="var-name">$name</span>, [<span class="var-type">mixed</span> <span class="var-name">$value</span> = <span class="var-default">NULL</span>])
|
| 1641 |
|
|
</div>
|
| 1642 |
|
|
|
| 1643 |
|
|
<ul class="parameters">
|
| 1644 |
|
|
<li>
|
| 1645 |
|
|
<span class="var-type">string</span>
|
| 1646 |
|
|
<span class="var-name">$name</span><span class="var-description">: attribute name</span> </li>
|
| 1647 |
|
|
<li>
|
| 1648 |
|
|
<span class="var-type">mixed</span>
|
| 1649 |
|
|
<span class="var-name">$value</span><span class="var-description">: the value</span> </li>
|
| 1650 |
|
|
</ul>
|
| 1651 |
|
|
|
| 1652 |
|
|
|
| 1653 |
|
|
</div>
|
| 1654 |
|
|
<a name="methodset_data_all_slaves" id="set_data_all_slaves"><!-- --></a>
|
| 1655 |
|
|
<div class="oddrow">
|
| 1656 |
|
|
|
| 1657 |
|
|
<div class="method-header">
|
| 1658 |
|
|
<span class="method-title">set_data_all_slaves</span> (line <span class="line-number">245</span>)
|
| 1659 |
|
|
</div>
|
| 1660 |
|
|
|
| 1661 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1662 |
|
|
<p class="short-description">This function will call set_slave_data for all slaves should be called when value of parent changes</p>
|
| 1663 |
|
|
|
| 1664 |
|
|
<div class="method-signature">
|
| 1665 |
|
|
<span class="method-result">void</span>
|
| 1666 |
|
|
<span class="method-name">
|
| 1667 |
|
|
set_data_all_slaves
|
| 1668 |
|
|
</span>
|
| 1669 |
|
|
(<span class="var-type">string</span> <span class="var-name">$parentValue</span>)
|
| 1670 |
|
|
</div>
|
| 1671 |
|
|
|
| 1672 |
|
|
<ul class="parameters">
|
| 1673 |
|
|
<li>
|
| 1674 |
|
|
<span class="var-type">string</span>
|
| 1675 |
|
|
<span class="var-name">$parentValue</span><span class="var-description">: - the current value of parent</span> </li>
|
| 1676 |
|
|
</ul>
|
| 1677 |
|
|
|
| 1678 |
|
|
|
| 1679 |
|
|
</div>
|
| 1680 |
|
|
<a name="methodset_disabled" id="set_disabled"><!-- --></a>
|
| 1681 |
|
|
<div class="evenrow">
|
| 1682 |
|
|
|
| 1683 |
|
|
<div class="method-header">
|
| 1684 |
|
|
<span class="method-title">set_disabled</span> (line <span class="line-number">322</span>)
|
| 1685 |
|
|
</div>
|
| 1686 |
|
|
|
| 1687 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1688 |
|
|
<p class="short-description">Sets the disabled element flag</p>
|
| 1689 |
|
|
|
| 1690 |
|
|
<div class="method-signature">
|
| 1691 |
|
|
<span class="method-result">void</span>
|
| 1692 |
|
|
<span class="method-name">
|
| 1693 |
|
|
set_disabled
|
| 1694 |
|
|
</span>
|
| 1695 |
|
|
(<span class="var-type">bool</span> <span class="var-name">$flag</span>)
|
| 1696 |
|
|
</div>
|
| 1697 |
|
|
|
| 1698 |
|
|
<ul class="parameters">
|
| 1699 |
|
|
<li>
|
| 1700 |
|
|
<span class="var-type">bool</span>
|
| 1701 |
|
|
<span class="var-name">$flag</span><span class="var-description">: disabled</span> </li>
|
| 1702 |
|
|
</ul>
|
| 1703 |
|
|
|
| 1704 |
|
|
|
| 1705 |
|
|
</div>
|
| 1706 |
|
|
<a name="methodset_element_name" id="set_element_name"><!-- --></a>
|
| 1707 |
|
|
<div class="oddrow">
|
| 1708 |
|
|
|
| 1709 |
|
|
<div class="method-header">
|
| 1710 |
|
|
<span class="method-title">set_element_name</span> (line <span class="line-number">514</span>)
|
| 1711 |
|
|
</div>
|
| 1712 |
|
|
|
| 1713 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1714 |
|
|
<p class="short-description">This allows you to force the element name to whatever you like, so you don't have to use the default name, which is generated based on the label.</p>
|
| 1715 |
|
|
|
| 1716 |
|
|
<div class="method-signature">
|
| 1717 |
|
|
<span class="method-result">none</span>
|
| 1718 |
|
|
<span class="method-name">
|
| 1719 |
|
|
set_element_name
|
| 1720 |
|
|
</span>
|
| 1721 |
|
|
(<span class="var-type">string</span> <span class="var-name">$name</span>)
|
| 1722 |
|
|
</div>
|
| 1723 |
|
|
|
| 1724 |
|
|
<ul class="parameters">
|
| 1725 |
|
|
<li>
|
| 1726 |
|
|
<span class="var-type">string</span>
|
| 1727 |
|
|
<span class="var-name">$name</span><span class="var-description">: the form element's name</span> </li>
|
| 1728 |
|
|
</ul>
|
| 1729 |
|
|
|
| 1730 |
|
|
|
| 1731 |
|
|
</div>
|
| 1732 |
|
|
<a name="methodset_error_message" id="set_error_message"><!-- --></a>
|
| 1733 |
|
|
<div class="evenrow">
|
| 1734 |
|
|
|
| 1735 |
|
|
<div class="method-header">
|
| 1736 |
|
|
<span class="method-title">set_error_message</span> (line <span class="line-number">432</span>)
|
| 1737 |
|
|
</div>
|
| 1738 |
|
|
|
| 1739 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1740 |
|
|
<p class="short-description">Defines error message text and sets the error flag to true</p>
|
| 1741 |
|
|
|
| 1742 |
|
|
<div class="method-signature">
|
| 1743 |
|
|
<span class="method-result">void</span>
|
| 1744 |
|
|
<span class="method-name">
|
| 1745 |
|
|
set_error_message
|
| 1746 |
|
|
</span>
|
| 1747 |
|
|
(<span class="var-type">mesage</span> <span class="var-name">$message</span>, [<span class="var-type">label</span> <span class="var-name">$label</span> = <span class="var-default">NULL</span>])
|
| 1748 |
|
|
</div>
|
| 1749 |
|
|
|
| 1750 |
|
|
<ul class="parameters">
|
| 1751 |
|
|
<li>
|
| 1752 |
|
|
<span class="var-type">mesage</span>
|
| 1753 |
|
|
<span class="var-name">$message</span><span class="var-description">: text - error message</span> </li>
|
| 1754 |
|
|
<li>
|
| 1755 |
|
|
<span class="var-type">label</span>
|
| 1756 |
|
|
<span class="var-name">$label</span><span class="var-description">: text - a label to provide for the error. This is only needed for a complex element that has multiple 'hidden/magic' fields.</span> </li>
|
| 1757 |
|
|
</ul>
|
| 1758 |
|
|
|
| 1759 |
|
|
|
| 1760 |
|
|
</div>
|
| 1761 |
|
|
<a name="methodset_form_name" id="set_form_name"><!-- --></a>
|
| 1762 |
|
|
<div class="oddrow">
|
| 1763 |
|
|
|
| 1764 |
|
|
<div class="method-header">
|
| 1765 |
|
|
<span class="method-title">set_form_name</span> (line <span class="line-number">263</span>)
|
| 1766 |
|
|
</div>
|
| 1767 |
|
|
|
| 1768 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1769 |
|
|
<p class="short-description">in case anyone in JS land needs the name of the form that this element lives in</p>
|
| 1770 |
|
|
|
| 1771 |
|
|
<div class="method-signature">
|
| 1772 |
|
|
<span class="method-result">void</span>
|
| 1773 |
|
|
<span class="method-name">
|
| 1774 |
|
|
set_form_name
|
| 1775 |
|
|
</span>
|
| 1776 |
|
|
(<span class="var-type">string</span> <span class="var-name">$name</span>)
|
| 1777 |
|
|
</div>
|
| 1778 |
|
|
|
| 1779 |
|
|
<ul class="parameters">
|
| 1780 |
|
|
<li>
|
| 1781 |
|
|
<span class="var-type">string</span>
|
| 1782 |
|
|
<span class="var-name">$name</span><span class="var-description">: - the form name</span> </li>
|
| 1783 |
|
|
</ul>
|
| 1784 |
|
|
|
| 1785 |
|
|
|
| 1786 |
|
|
</div>
|
| 1787 |
|
|
<a name="methodset_label_text" id="set_label_text"><!-- --></a>
|
| 1788 |
|
|
<div class="evenrow">
|
| 1789 |
|
|
|
| 1790 |
|
|
<div class="method-header">
|
| 1791 |
|
|
<span class="method-title">set_label_text</span> (line <span class="line-number">209</span>)
|
| 1792 |
|
|
</div>
|
| 1793 |
|
|
|
| 1794 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1795 |
|
|
<p class="short-description">This function will set the label for the element</p>
|
| 1796 |
|
|
|
| 1797 |
|
|
<div class="method-signature">
|
| 1798 |
|
|
<span class="method-result">void</span>
|
| 1799 |
|
|
<span class="method-name">
|
| 1800 |
|
|
set_label_text
|
| 1801 |
|
|
</span>
|
| 1802 |
|
|
(<span class="var-type">label</span> <span class="var-name">$label</span>)
|
| 1803 |
|
|
</div>
|
| 1804 |
|
|
|
| 1805 |
|
|
<ul class="parameters">
|
| 1806 |
|
|
<li>
|
| 1807 |
|
|
<span class="var-type">label</span>
|
| 1808 |
|
|
<span class="var-name">$label</span><span class="var-description">: string</span> </li>
|
| 1809 |
|
|
</ul>
|
| 1810 |
|
|
|
| 1811 |
|
|
|
| 1812 |
|
|
</div>
|
| 1813 |
|
|
<a name="methodset_required" id="set_required"><!-- --></a>
|
| 1814 |
|
|
<div class="oddrow">
|
| 1815 |
|
|
|
| 1816 |
|
|
<div class="method-header">
|
| 1817 |
|
|
<span class="method-title">set_required</span> (line <span class="line-number">291</span>)
|
| 1818 |
|
|
</div>
|
| 1819 |
|
|
|
| 1820 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1821 |
|
|
<p class="short-description">This function set the elements required state</p>
|
| 1822 |
|
|
|
| 1823 |
|
|
<div class="method-signature">
|
| 1824 |
|
|
<span class="method-result">void</span>
|
| 1825 |
|
|
<span class="method-name">
|
| 1826 |
|
|
set_required
|
| 1827 |
|
|
</span>
|
| 1828 |
|
|
(<span class="var-type">bool</span> <span class="var-name">$required</span>)
|
| 1829 |
|
|
</div>
|
| 1830 |
|
|
|
| 1831 |
|
|
<ul class="parameters">
|
| 1832 |
|
|
<li>
|
| 1833 |
|
|
<span class="var-type">bool</span>
|
| 1834 |
|
|
<span class="var-name">$required</span><span class="var-description">: required</span> </li>
|
| 1835 |
|
|
</ul>
|
| 1836 |
|
|
|
| 1837 |
|
|
|
| 1838 |
|
|
</div>
|
| 1839 |
|
|
<a name="methodset_required_symbol" id="set_required_symbol"><!-- --></a>
|
| 1840 |
|
|
<div class="evenrow">
|
| 1841 |
|
|
|
| 1842 |
|
|
<div class="method-header">
|
| 1843 |
|
|
<span class="method-title">set_required_symbol</span> (line <span class="line-number">714</span>)
|
| 1844 |
|
|
</div>
|
| 1845 |
|
|
|
| 1846 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1847 |
|
|
<p class="short-description">This allows you to customize the require string marker</p>
|
| 1848 |
|
|
|
| 1849 |
|
|
<div class="method-signature">
|
| 1850 |
|
|
<span class="method-result">void</span>
|
| 1851 |
|
|
<span class="method-name">
|
| 1852 |
|
|
set_required_symbol
|
| 1853 |
|
|
</span>
|
| 1854 |
|
|
(<span class="var-type">string</span> <span class="var-name">$symbol</span>)
|
| 1855 |
|
|
</div>
|
| 1856 |
|
|
|
| 1857 |
|
|
<ul class="parameters">
|
| 1858 |
|
|
<li>
|
| 1859 |
|
|
<span class="var-type">string</span>
|
| 1860 |
|
|
<span class="var-name">$symbol</span> </li>
|
| 1861 |
|
|
</ul>
|
| 1862 |
|
|
|
| 1863 |
|
|
|
| 1864 |
|
|
</div>
|
| 1865 |
|
|
<a name="methodset_slave_data" id="set_slave_data"><!-- --></a>
|
| 1866 |
|
|
<div class="oddrow">
|
| 1867 |
|
|
|
| 1868 |
|
|
<div class="method-header">
|
| 1869 |
|
|
<span class="method-title">set_slave_data</span> (line <span class="line-number">189</span>)
|
| 1870 |
|
|
</div>
|
| 1871 |
|
|
|
| 1872 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1873 |
|
|
<p class="short-description">This function will set the data the parent wants to set for the slave</p>
|
| 1874 |
|
|
|
| 1875 |
|
|
<div class="method-signature">
|
| 1876 |
|
|
<span class="method-result">void</span>
|
| 1877 |
|
|
<span class="method-name">
|
| 1878 |
|
|
set_slave_data
|
| 1879 |
|
|
</span>
|
| 1880 |
|
|
(<span class="var-type">the</span> <span class="var-name">&$slave</span>, <span class="var-type">the</span> <span class="var-name">$parentValue</span>)
|
| 1881 |
|
|
</div>
|
| 1882 |
|
|
|
| 1883 |
|
|
<ul class="parameters">
|
| 1884 |
|
|
<li>
|
| 1885 |
|
|
<span class="var-type">the</span>
|
| 1886 |
|
|
<span class="var-name">&$slave</span><span class="var-description">: slave</span> </li>
|
| 1887 |
|
|
<li>
|
| 1888 |
|
|
<span class="var-type">the</span>
|
| 1889 |
|
|
<span class="var-name">$parentValue</span><span class="var-description">: value being set for the parent</span> </li>
|
| 1890 |
|
|
</ul>
|
| 1891 |
|
|
|
| 1892 |
|
|
|
| 1893 |
|
|
<hr class="separator" />
|
| 1894 |
|
|
<div class="notes">Redefined in descendants as:</div>
|
| 1895 |
|
|
<ul class="redefinitions">
|
| 1896 |
|
|
<li>
|
| 1897 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEListBoxMaster.html#methodset_slave_data">FEListBoxMaster::set_slave_data()</a>
|
| 1898 |
|
|
: This function will set the data the parent wants to set for the slave
|
| 1899 |
|
|
</li>
|
| 1900 |
|
|
</ul>
|
| 1901 |
|
|
</div>
|
| 1902 |
|
|
<a name="methodset_slave_elements" id="set_slave_elements"><!-- --></a>
|
| 1903 |
|
|
<div class="evenrow">
|
| 1904 |
|
|
|
| 1905 |
|
|
<div class="method-header">
|
| 1906 |
|
|
<span class="method-title">set_slave_elements</span> (line <span class="line-number">176</span>)
|
| 1907 |
|
|
</div>
|
| 1908 |
|
|
|
| 1909 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1910 |
|
|
<p class="short-description">This function will set the slaves of this element</p>
|
| 1911 |
|
|
|
| 1912 |
|
|
<div class="method-signature">
|
| 1913 |
|
|
<span class="method-result">void</span>
|
| 1914 |
|
|
<span class="method-name">
|
| 1915 |
|
|
set_slave_elements
|
| 1916 |
|
|
</span>
|
| 1917 |
|
|
(<span class="var-type">array</span> <span class="var-name">$slaveElements</span>)
|
| 1918 |
|
|
</div>
|
| 1919 |
|
|
|
| 1920 |
|
|
<ul class="parameters">
|
| 1921 |
|
|
<li>
|
| 1922 |
|
|
<span class="var-type">array</span>
|
| 1923 |
|
|
<span class="var-name">$slaveElements</span><span class="var-description">: of slave elements (element references &)</span> </li>
|
| 1924 |
|
|
</ul>
|
| 1925 |
|
|
|
| 1926 |
|
|
|
| 1927 |
|
|
</div>
|
| 1928 |
|
|
<a name="methodset_stripslashes" id="set_stripslashes"><!-- --></a>
|
| 1929 |
|
|
<div class="oddrow">
|
| 1930 |
|
|
|
| 1931 |
|
|
<div class="method-header">
|
| 1932 |
|
|
<span class="method-title">set_stripslashes</span> (line <span class="line-number">342</span>)
|
| 1933 |
|
|
</div>
|
| 1934 |
|
|
|
| 1935 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1936 |
|
|
<p class="short-description">This sets the stripslashes flag for this object.</p>
|
| 1937 |
|
|
|
| 1938 |
|
|
<div class="method-signature">
|
| 1939 |
|
|
<span class="method-result">void</span>
|
| 1940 |
|
|
<span class="method-name">
|
| 1941 |
|
|
set_stripslashes
|
| 1942 |
|
|
</span>
|
| 1943 |
|
|
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>])
|
| 1944 |
|
|
</div>
|
| 1945 |
|
|
|
| 1946 |
|
|
<ul class="parameters">
|
| 1947 |
|
|
<li>
|
| 1948 |
|
|
<span class="var-type">boolean</span>
|
| 1949 |
|
|
<span class="var-name">$flag</span> </li>
|
| 1950 |
|
|
</ul>
|
| 1951 |
|
|
|
| 1952 |
|
|
|
| 1953 |
|
|
</div>
|
| 1954 |
|
|
<a name="methodset_style_attribute" id="set_style_attribute"><!-- --></a>
|
| 1955 |
|
|
<div class="evenrow">
|
| 1956 |
|
|
|
| 1957 |
|
|
<div class="method-header">
|
| 1958 |
|
|
<span class="method-title">set_style_attribute</span> (line <span class="line-number">392</span>)
|
| 1959 |
|
|
</div>
|
| 1960 |
|
|
|
| 1961 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1962 |
|
|
<p class="short-description">Sets elements css attribute</p>
|
| 1963 |
|
|
|
| 1964 |
|
|
<div class="method-signature">
|
| 1965 |
|
|
<span class="method-result">void</span>
|
| 1966 |
|
|
<span class="method-name">
|
| 1967 |
|
|
set_style_attribute
|
| 1968 |
|
|
</span>
|
| 1969 |
|
|
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">mixed</span> <span class="var-name">$value</span>)
|
| 1970 |
|
|
</div>
|
| 1971 |
|
|
|
| 1972 |
|
|
<ul class="parameters">
|
| 1973 |
|
|
<li>
|
| 1974 |
|
|
<span class="var-type">string</span>
|
| 1975 |
|
|
<span class="var-name">$name</span><span class="var-description">: attribute name</span> </li>
|
| 1976 |
|
|
<li>
|
| 1977 |
|
|
<span class="var-type">mixed</span>
|
| 1978 |
|
|
<span class="var-name">$value</span><span class="var-description">: the value</span> </li>
|
| 1979 |
|
|
</ul>
|
| 1980 |
|
|
|
| 1981 |
|
|
|
| 1982 |
|
|
</div>
|
| 1983 |
|
|
<a name="methodset_tabindex" id="set_tabindex"><!-- --></a>
|
| 1984 |
|
|
<div class="oddrow">
|
| 1985 |
|
|
|
| 1986 |
|
|
<div class="method-header">
|
| 1987 |
|
|
<span class="method-title">set_tabindex</span> (line <span class="line-number">401</span>)
|
| 1988 |
|
|
</div>
|
| 1989 |
|
|
|
| 1990 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 1991 |
|
|
<p class="short-description">Sets the element's tab index</p>
|
| 1992 |
|
|
|
| 1993 |
|
|
<div class="method-signature">
|
| 1994 |
|
|
<span class="method-result">void</span>
|
| 1995 |
|
|
<span class="method-name">
|
| 1996 |
|
|
set_tabindex
|
| 1997 |
|
|
</span>
|
| 1998 |
|
|
(<span class="var-type">int</span> <span class="var-name">$index</span>)
|
| 1999 |
|
|
</div>
|
| 2000 |
|
|
|
| 2001 |
|
|
<ul class="parameters">
|
| 2002 |
|
|
<li>
|
| 2003 |
|
|
<span class="var-type">int</span>
|
| 2004 |
|
|
<span class="var-name">$index</span><span class="var-description">: the # for the tabindex</span> </li>
|
| 2005 |
|
|
</ul>
|
| 2006 |
|
|
|
| 2007 |
|
|
|
| 2008 |
|
|
</div>
|
| 2009 |
|
|
<a name="methodset_title" id="set_title"><!-- --></a>
|
| 2010 |
|
|
<div class="evenrow">
|
| 2011 |
|
|
|
| 2012 |
|
|
<div class="method-header">
|
| 2013 |
|
|
<span class="method-title">set_title</span> (line <span class="line-number">382</span>)
|
| 2014 |
|
|
</div>
|
| 2015 |
|
|
|
| 2016 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 2017 |
|
|
<p class="short-description">Sets elements title text</p>
|
| 2018 |
|
|
|
| 2019 |
|
|
<div class="method-signature">
|
| 2020 |
|
|
<span class="method-result">void</span>
|
| 2021 |
|
|
<span class="method-name">
|
| 2022 |
|
|
set_title
|
| 2023 |
|
|
</span>
|
| 2024 |
|
|
(<span class="var-type">string</span> <span class="var-name">$title</span>)
|
| 2025 |
|
|
</div>
|
| 2026 |
|
|
|
| 2027 |
|
|
<ul class="parameters">
|
| 2028 |
|
|
<li>
|
| 2029 |
|
|
<span class="var-type">string</span>
|
| 2030 |
|
|
<span class="var-name">$title</span><span class="var-description">: title</span> </li>
|
| 2031 |
|
|
</ul>
|
| 2032 |
|
|
|
| 2033 |
|
|
|
| 2034 |
|
|
</div>
|
| 2035 |
|
|
<a name="methodset_value" id="set_value"><!-- --></a>
|
| 2036 |
|
|
<div class="oddrow">
|
| 2037 |
|
|
|
| 2038 |
|
|
<div class="method-header">
|
| 2039 |
|
|
<span class="method-title">set_value</span> (line <span class="line-number">234</span>)
|
| 2040 |
|
|
</div>
|
| 2041 |
|
|
|
| 2042 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 2043 |
|
|
<p class="short-description">This function will set the initial value for the element</p>
|
| 2044 |
|
|
|
| 2045 |
|
|
<div class="method-signature">
|
| 2046 |
|
|
<span class="method-result">void</span>
|
| 2047 |
|
|
<span class="method-name">
|
| 2048 |
|
|
set_value
|
| 2049 |
|
|
</span>
|
| 2050 |
|
|
(<span class="var-type">value</span> <span class="var-name">$value</span>)
|
| 2051 |
|
|
</div>
|
| 2052 |
|
|
|
| 2053 |
|
|
<ul class="parameters">
|
| 2054 |
|
|
<li>
|
| 2055 |
|
|
<span class="var-type">value</span>
|
| 2056 |
|
|
<span class="var-name">$value</span><span class="var-description">: mixed</span> </li>
|
| 2057 |
|
|
</ul>
|
| 2058 |
|
|
|
| 2059 |
|
|
|
| 2060 |
|
|
<hr class="separator" />
|
| 2061 |
|
|
<div class="notes">Redefined in descendants as:</div>
|
| 2062 |
|
|
<ul class="redefinitions">
|
| 2063 |
|
|
<li>
|
| 2064 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEComboListBox.html#methodset_value">FEComboListBox::set_value()</a>
|
| 2065 |
|
|
: This function will set the initial value for the element
|
| 2066 |
|
|
</li>
|
| 2067 |
|
|
<li>
|
| 2068 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEDate.html#methodset_value">FEDate::set_value()</a>
|
| 2069 |
|
|
: This function sets the default values for the date element The parameter should be a string representation of the date in ISO 8601 format.
|
| 2070 |
|
|
</li>
|
| 2071 |
|
|
</ul>
|
| 2072 |
|
|
</div>
|
| 2073 |
|
|
<a name="methodvalidate" id="validate"><!-- --></a>
|
| 2074 |
|
|
<div class="evenrow">
|
| 2075 |
|
|
|
| 2076 |
|
|
<div class="method-header">
|
| 2077 |
|
|
<span class="method-title">validate</span> (line <span class="line-number">543</span>)
|
| 2078 |
|
|
</div>
|
| 2079 |
|
|
|
| 2080 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 2081 |
|
|
<p class="short-description">This function performs the actual validation It is called only if the validation is required by this element</p>
|
| 2082 |
|
|
<p class="description"><p>This function is responsible for performing complete validation and setting the appropriate error message in case of a failed validation</p></p>
|
| 2083 |
|
|
|
| 2084 |
|
|
<div class="method-signature">
|
| 2085 |
|
|
<span class="method-result">void</span>
|
| 2086 |
|
|
<span class="method-name">
|
| 2087 |
|
|
validate
|
| 2088 |
|
|
</span>
|
| 2089 |
|
|
(<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span> <span class="var-name">&$_FormValidation</span>)
|
| 2090 |
|
|
</div>
|
| 2091 |
|
|
|
| 2092 |
|
|
<ul class="parameters">
|
| 2093 |
|
|
<li>
|
| 2094 |
|
|
<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>
|
| 2095 |
|
|
<span class="var-name">&$_FormValidation</span><span class="var-description">: object.</span> </li>
|
| 2096 |
|
|
</ul>
|
| 2097 |
|
|
|
| 2098 |
|
|
|
| 2099 |
|
|
<hr class="separator" />
|
| 2100 |
|
|
<div class="notes">Redefined in descendants as:</div>
|
| 2101 |
|
|
<ul class="redefinitions">
|
| 2102 |
|
|
<li>
|
| 2103 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methodvalidate">FEDataList::validate()</a>
|
| 2104 |
|
|
: This function is responsible for performing complete validation and setting the appropriate error message in case of a failed validation
|
| 2105 |
|
|
</li>
|
| 2106 |
|
|
<li>
|
| 2107 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FENestedListBox.html#methodvalidate">FENestedListBox::validate()</a>
|
| 2108 |
|
|
: This function is responsible for performing complete validation and setting the appropriate error message in case of a failed validation
|
| 2109 |
|
|
</li>
|
| 2110 |
|
|
<li>
|
| 2111 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEComboListBox.html#methodvalidate">FEComboListBox::validate()</a>
|
| 2112 |
|
|
: This function is responsible for performing complete validation and setting the appropriate error message in case of a failed validation
|
| 2113 |
|
|
</li>
|
| 2114 |
|
|
<li>
|
| 2115 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEDate.html#methodvalidate">FEDate::validate()</a>
|
| 2116 |
|
|
: This function is responsible for performing complete validation and setting the appropriate error message in case of a failed validation
|
| 2117 |
|
|
</li>
|
| 2118 |
|
|
<li>
|
| 2119 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FETextArea.html#methodvalidate">FETextArea::validate()</a>
|
| 2120 |
|
|
: This method validates the data for this Form Element.
|
| 2121 |
|
|
</li>
|
| 2122 |
|
|
<li>
|
| 2123 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEFile.html#methodvalidate">FEFile::validate()</a>
|
| 2124 |
|
|
: This method validates the data for this Form Element.
|
| 2125 |
|
|
</li>
|
| 2126 |
|
|
<li>
|
| 2127 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FENumber.html#methodvalidate">FENumber::validate()</a>
|
| 2128 |
|
|
: This method validates the data for this Form Element.
|
| 2129 |
|
|
</li>
|
| 2130 |
|
|
<li>
|
| 2131 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FENumberFloat.html#methodvalidate">FENumberFloat::validate()</a>
|
| 2132 |
|
|
: This method validates the data for this Form Element.
|
| 2133 |
|
|
</li>
|
| 2134 |
|
|
<li>
|
| 2135 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FENumberPrice.html#methodvalidate">FENumberPrice::validate()</a>
|
| 2136 |
|
|
: This method validates the data for this Form Element.
|
| 2137 |
|
|
</li>
|
| 2138 |
|
|
<li>
|
| 2139 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FENumberInRange.html#methodvalidate">FENumberInRange::validate()</a>
|
| 2140 |
|
|
: This method validates the data for this Form Element.
|
| 2141 |
|
|
</li>
|
| 2142 |
|
|
<li>
|
| 2143 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEPassword.html#methodvalidate">FEPassword::validate()</a>
|
| 2144 |
|
|
: This function performs the actual validation It is called only if the validation is required by this element
|
| 2145 |
|
|
</li>
|
| 2146 |
|
|
<li>
|
| 2147 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEConfirmPassword.html#methodvalidate">FEConfirmPassword::validate()</a>
|
| 2148 |
|
|
: This function performs the actual validation It is called only if the validation is required by this element
|
| 2149 |
|
|
</li>
|
| 2150 |
|
|
<li>
|
| 2151 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEName.html#methodvalidate">FEName::validate()</a>
|
| 2152 |
|
|
: This method validates the data for this Form Element.
|
| 2153 |
|
|
</li>
|
| 2154 |
|
|
<li>
|
| 2155 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEEmail.html#methodvalidate">FEEmail::validate()</a>
|
| 2156 |
|
|
: This method validates the data for this Form Element.
|
| 2157 |
|
|
</li>
|
| 2158 |
|
|
<li>
|
| 2159 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEEmailMany.html#methodvalidate">FEEmailMany::validate()</a>
|
| 2160 |
|
|
: This method validates the data for this Form Element.
|
| 2161 |
|
|
</li>
|
| 2162 |
|
|
<li>
|
| 2163 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEDomainName.html#methodvalidate">FEDomainName::validate()</a>
|
| 2164 |
|
|
: This method validates the data for this Form Element.
|
| 2165 |
|
|
</li>
|
| 2166 |
|
|
<li>
|
| 2167 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEHostNameWithPort.html#methodvalidate">FEHostNameWithPort::validate()</a>
|
| 2168 |
|
|
: This method validates the data for this Form Element.
|
| 2169 |
|
|
</li>
|
| 2170 |
|
|
<li>
|
| 2171 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEIPAddress.html#methodvalidate">FEIPAddress::validate()</a>
|
| 2172 |
|
|
: This method validates the data for this Form Element.
|
| 2173 |
|
|
</li>
|
| 2174 |
|
|
<li>
|
| 2175 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEUrl.html#methodvalidate">FEUrl::validate()</a>
|
| 2176 |
|
|
: This method validates the data for this Form Element.
|
| 2177 |
|
|
</li>
|
| 2178 |
|
|
<li>
|
| 2179 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEUrlStrict.html#methodvalidate">FEUrlStrict::validate()</a>
|
| 2180 |
|
|
: This method validates the data for this Form Element.
|
| 2181 |
|
|
</li>
|
| 2182 |
|
|
<li>
|
| 2183 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FEZipcode.html#methodvalidate">FEZipcode::validate()</a>
|
| 2184 |
|
|
: This method validates the data for this Form Element.
|
| 2185 |
|
|
</li>
|
| 2186 |
|
|
<li>
|
| 2187 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FERegEx.html#methodvalidate">FERegEx::validate()</a>
|
| 2188 |
|
|
: This method validates the data for this Form Element.
|
| 2189 |
|
|
</li>
|
| 2190 |
|
|
</ul>
|
| 2191 |
|
|
</div>
|
| 2192 |
|
|
<a name="method_build_element_attributes" id="_build_element_attributes"><!-- --></a>
|
| 2193 |
|
|
<div class="oddrow">
|
| 2194 |
|
|
|
| 2195 |
|
|
<div class="method-header">
|
| 2196 |
|
|
<span class="method-title">_build_element_attributes</span> (line <span class="line-number">723</span>)
|
| 2197 |
|
|
</div>
|
| 2198 |
|
|
|
| 2199 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 2200 |
|
|
<p class="short-description">This function builds the element form attributes</p>
|
| 2201 |
|
|
<ul class="tags">
|
| 2202 |
|
|
<li><span class="field">return:</span> attributes</li>
|
| 2203 |
|
|
</ul>
|
| 2204 |
|
|
|
| 2205 |
|
|
<div class="method-signature">
|
| 2206 |
|
|
<span class="method-result">array</span>
|
| 2207 |
|
|
<span class="method-name">
|
| 2208 |
|
|
_build_element_attributes
|
| 2209 |
|
|
</span>
|
| 2210 |
|
|
()
|
| 2211 |
|
|
</div>
|
| 2212 |
|
|
|
| 2213 |
|
|
|
| 2214 |
|
|
|
| 2215 |
|
|
</div>
|
| 2216 |
|
|
<a name="method_build_javascript" id="_build_javascript"><!-- --></a>
|
| 2217 |
|
|
<div class="evenrow">
|
| 2218 |
|
|
|
| 2219 |
|
|
<div class="method-header">
|
| 2220 |
|
|
<span class="method-title">_build_javascript</span> (line <span class="line-number">651</span>)
|
| 2221 |
|
|
</div>
|
| 2222 |
|
|
|
| 2223 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 2224 |
|
|
<p class="short-description">This function builds the complete javaScript events code for the element</p>
|
| 2225 |
|
|
<ul class="tags">
|
| 2226 |
|
|
<li><span class="field">return:</span> - attributes</li>
|
| 2227 |
|
|
</ul>
|
| 2228 |
|
|
|
| 2229 |
|
|
<div class="method-signature">
|
| 2230 |
|
|
<span class="method-result">array</span>
|
| 2231 |
|
|
<span class="method-name">
|
| 2232 |
|
|
_build_javascript
|
| 2233 |
|
|
</span>
|
| 2234 |
|
|
()
|
| 2235 |
|
|
</div>
|
| 2236 |
|
|
|
| 2237 |
|
|
|
| 2238 |
|
|
|
| 2239 |
|
|
</div>
|
| 2240 |
|
|
<a name="method_do_validation" id="_do_validation"><!-- --></a>
|
| 2241 |
|
|
<div class="oddrow">
|
| 2242 |
|
|
|
| 2243 |
|
|
<div class="method-header">
|
| 2244 |
|
|
<span class="method-title">_do_validation</span> (line <span class="line-number">554</span>)
|
| 2245 |
|
|
</div>
|
| 2246 |
|
|
|
| 2247 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 2248 |
|
|
<p class="short-description">This function checks if the validation is nesseccary and calls the validate method</p>
|
| 2249 |
|
|
|
| 2250 |
|
|
<div class="method-signature">
|
| 2251 |
|
|
<span class="method-result">void</span>
|
| 2252 |
|
|
<span class="method-name">
|
| 2253 |
|
|
_do_validation
|
| 2254 |
|
|
</span>
|
| 2255 |
|
|
(<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span> <span class="var-name">&$_FormValidation</span>)
|
| 2256 |
|
|
</div>
|
| 2257 |
|
|
|
| 2258 |
|
|
<ul class="parameters">
|
| 2259 |
|
|
<li>
|
| 2260 |
|
|
<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>
|
| 2261 |
|
|
<span class="var-name">&$_FormValidation</span><span class="var-description">: object.</span> </li>
|
| 2262 |
|
|
</ul>
|
| 2263 |
|
|
|
| 2264 |
|
|
|
| 2265 |
|
|
</div>
|
| 2266 |
|
|
|
| 2267 |
|
|
</div>
|
| 2268 |
|
|
</div>
|
| 2269 |
|
|
|
| 2270 |
|
|
|
| 2271 |
|
|
<p class="notes" id="credit">
|
| 2272 |
|
|
Documentation generated on Thu, 1 Apr 2004 09:38:50 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a>
|
| 2273 |
|
|
</p>
|
| 2274 |
|
|
</div></body>
|
| 2275 |
|
|
</html>
|
Parent Directory
| 
Revision Log
