| 1 |
<?xml version="1.0" encoding="iso-8859-1"?> |
| 2 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 3 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
| 4 |
<head> |
| 5 |
<!-- template designed by Marco Von Ballmoos --> |
| 6 |
<title>Docs For Class FEFile</title> |
| 7 |
<link rel="stylesheet" href="../../media/stylesheet.css" /> |
| 8 |
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> |
| 9 |
</head> |
| 10 |
<body> |
| 11 |
<div class="page-body"> |
| 12 |
|
| 13 |
<h2 class="class-name">Class FEFile</h2> |
| 14 |
|
| 15 |
<a name="sec-description"></a> |
| 16 |
<div class="info-box"> |
| 17 |
<div class="info-box-title">Description</div> |
| 18 |
<div class="nav-bar"> |
| 19 |
<span class="disabled">Description</span> | |
| 20 |
<a href="#sec-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 FileUpload FormElement which builds a input field of type="file". This automagically handles the case of a confirmation page.</p> |
| 27 |
<ul class="tags"> |
| 28 |
<li><span class="field">copyright:</span> LGPL - See LICENCE</li> |
| 29 |
<li><span class="field">author:</span> Dave Brondsema <<a href="mailto:dave@brondsema.net">dave@brondsema.net</a>></li> |
| 30 |
</ul> |
| 31 |
<p class="notes"> |
| 32 |
Located in <a class="field" href="_form_form_elements_FEFile_inc.html">/form/form_elements/FEFile.inc</a> (line <span class="field">27</span>) |
| 33 |
</p> |
| 34 |
|
| 35 |
|
| 36 |
<pre><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a> |
| 37 |
| |
| 38 |
--<a href="../../phpHtmlLib/FormProcessing/FEText.html">FEText</a> |
| 39 |
| |
| 40 |
--FEFile</pre> |
| 41 |
|
| 42 |
</div> |
| 43 |
</div> |
| 44 |
|
| 45 |
|
| 46 |
|
| 47 |
<a name="sec-var-summary"></a> |
| 48 |
<div class="info-box"> |
| 49 |
<div class="info-box-title">Variable Summary</span></div> |
| 50 |
<div class="nav-bar"> |
| 51 |
<a href="#sec-description">Description</a> | |
| 52 |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
| 53 |
| |
| 54 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 55 |
|
| 56 |
</div> |
| 57 |
<div class="info-box-body"> |
| 58 |
<div class="var-summary"> |
| 59 |
<div class="var-title"> |
| 60 |
<span class="var-type">mixed</span> |
| 61 |
<a href="#$_files_info" title="details" class="var-name">$_files_info</a> |
| 62 |
</div> |
| 63 |
<div class="var-title"> |
| 64 |
<span class="var-type">mixed</span> |
| 65 |
<a href="#$_max_size" title="details" class="var-name">$_max_size</a> |
| 66 |
</div> |
| 67 |
<div class="var-title"> |
| 68 |
<span class="var-type">mixed</span> |
| 69 |
<a href="#$_temp_dir" title="details" class="var-name">$_temp_dir</a> |
| 70 |
</div> |
| 71 |
<div class="var-title"> |
| 72 |
<span class="var-type">mixed</span> |
| 73 |
<a href="#$_valid_types" title="details" class="var-name">$_valid_types</a> |
| 74 |
</div> |
| 75 |
</div> |
| 76 |
</div> |
| 77 |
</div> |
| 78 |
|
| 79 |
<a name="sec-method-summary"></a> |
| 80 |
<div class="info-box"> |
| 81 |
<div class="info-box-title">Method Summary</span></div> |
| 82 |
<div class="nav-bar"> |
| 83 |
<a href="#sec-description">Description</a> | |
| 84 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 85 |
|
| 86 |
| |
| 87 |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
| 88 |
</div> |
| 89 |
<div class="info-box-body"> |
| 90 |
<div class="method-summary"> |
| 91 |
|
| 92 |
<div class="method-definition"> |
| 93 |
<span class="method-result">void</span> |
| 94 |
<a href="#add_valid_type" title="details" class="method-name">add_valid_type</a> |
| 95 |
(<span class="var-type">string</span> <span class="var-name">$mime_type</span>) |
| 96 |
</div> |
| 97 |
|
| 98 |
<div class="method-definition"> |
| 99 |
<span class="method-result"><a href="../../phpHtmlLib/INPUTtag.html">INPUTtag</a></span> |
| 100 |
<a href="#get_confirm_element" title="details" class="method-name">get_confirm_element</a> |
| 101 |
() |
| 102 |
</div> |
| 103 |
|
| 104 |
<div class="method-definition"> |
| 105 |
<span class="method-result">object</span> |
| 106 |
<a href="#get_element" title="details" class="method-name">get_element</a> |
| 107 |
() |
| 108 |
</div> |
| 109 |
|
| 110 |
<div class="method-definition"> |
| 111 |
<span class="method-result">array</span> |
| 112 |
<a href="#get_file_info" title="details" class="method-name">get_file_info</a> |
| 113 |
() |
| 114 |
</div> |
| 115 |
|
| 116 |
<div class="method-definition"> |
| 117 |
<span class="method-result">integer</span> |
| 118 |
<a href="#get_max_size" title="details" class="method-name">get_max_size</a> |
| 119 |
(<span class="var-type">mixed</span> <span class="var-name">$max_size</span>) |
| 120 |
</div> |
| 121 |
|
| 122 |
<div class="method-definition"> |
| 123 |
<span class="method-result">string</span> |
| 124 |
<a href="#get_pre_confirm_value" title="details" class="method-name">get_pre_confirm_value</a> |
| 125 |
() |
| 126 |
</div> |
| 127 |
|
| 128 |
<div class="method-definition"> |
| 129 |
<span class="method-result">string</span> |
| 130 |
<a href="#get_temp_dir" title="details" class="method-name">get_temp_dir</a> |
| 131 |
() |
| 132 |
</div> |
| 133 |
|
| 134 |
<div class="method-definition"> |
| 135 |
<span class="method-result">mixed</span> |
| 136 |
<a href="#get_value" title="details" class="method-name">get_value</a> |
| 137 |
() |
| 138 |
</div> |
| 139 |
|
| 140 |
<div class="method-definition"> |
| 141 |
<span class="method-result">string</span> |
| 142 |
<a href="#get_value_text" title="details" class="method-name">get_value_text</a> |
| 143 |
(<span class="var-type">mixed</span> <span class="var-name">0</span>) |
| 144 |
</div> |
| 145 |
|
| 146 |
<div class="method-definition"> |
| 147 |
<span class="method-result">void</span> |
| 148 |
<a href="#set_max_size" title="details" class="method-name">set_max_size</a> |
| 149 |
(<span class="var-type">integer</span> <span class="var-name">$max_size</span>) |
| 150 |
</div> |
| 151 |
|
| 152 |
<div class="method-definition"> |
| 153 |
<span class="method-result">void</span> |
| 154 |
<a href="#set_temp_dir" title="details" class="method-name">set_temp_dir</a> |
| 155 |
(<span class="var-type">string</span> <span class="var-name">$dir</span>) |
| 156 |
</div> |
| 157 |
|
| 158 |
<div class="method-definition"> |
| 159 |
<span class="method-result">void</span> |
| 160 |
<a href="#validate" title="details" class="method-name">validate</a> |
| 161 |
(<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span> <span class="var-name">&$_FormValidation</span>) |
| 162 |
</div> |
| 163 |
|
| 164 |
<div class="method-definition"> |
| 165 |
<span class="method-result">void</span> |
| 166 |
<a href="#_populate_file_info" title="details" class="method-name">_populate_file_info</a> |
| 167 |
() |
| 168 |
</div> |
| 169 |
|
| 170 |
<div class="method-definition"> |
| 171 |
<span class="method-result">void</span> |
| 172 |
<a href="#_pre_confirm" title="details" class="method-name">_pre_confirm</a> |
| 173 |
() |
| 174 |
</div> |
| 175 |
</div> |
| 176 |
</div> |
| 177 |
</div> |
| 178 |
|
| 179 |
<a name="sec-vars"></a> |
| 180 |
<div class="info-box"> |
| 181 |
<div class="info-box-title">Variables</div> |
| 182 |
<div class="nav-bar"> |
| 183 |
<a href="#sec-description">Description</a> | |
| 184 |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
| 185 |
|
| 186 |
|
| 187 |
| |
| 188 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 189 |
|
| 190 |
</div> |
| 191 |
<div class="info-box-body"> |
| 192 |
<a name="var$_files_info" id="$_files_info"><!-- --></A> |
| 193 |
<div class="evenrow"> |
| 194 |
|
| 195 |
<div class="var-header"> |
| 196 |
<span class="var-title"> |
| 197 |
<span class="var-type">mixed</span> |
| 198 |
<span class="var-name">$_files_info</span> |
| 199 |
= <span class="var-default">array('name' => '',<br /> 'type' => '',<br /> 'size' => '',<br /> 'tmp_name' => '')</span> (line <span class="line-number">34</span>) |
| 200 |
</span> |
| 201 |
</div> |
| 202 |
|
| 203 |
<!-- ========== Info from phpDoc block ========= --> |
| 204 |
<p class="short-description">The $_FILES information about the submitted file.</p> |
| 205 |
|
| 206 |
|
| 207 |
|
| 208 |
|
| 209 |
|
| 210 |
</div> |
| 211 |
<a name="var$_max_size" id="$_max_size"><!-- --></A> |
| 212 |
<div class="oddrow"> |
| 213 |
|
| 214 |
<div class="var-header"> |
| 215 |
<span class="var-title"> |
| 216 |
<span class="var-type">mixed</span> |
| 217 |
<span class="var-name">$_max_size</span> |
| 218 |
(line <span class="line-number">55</span>) |
| 219 |
</span> |
| 220 |
</div> |
| 221 |
|
| 222 |
<!-- ========== Info from phpDoc block ========= --> |
| 223 |
<p class="short-description">max size in bytes determined by user</p> |
| 224 |
|
| 225 |
|
| 226 |
|
| 227 |
|
| 228 |
|
| 229 |
</div> |
| 230 |
<a name="var$_temp_dir" id="$_temp_dir"><!-- --></A> |
| 231 |
<div class="evenrow"> |
| 232 |
|
| 233 |
<div class="var-header"> |
| 234 |
<span class="var-title"> |
| 235 |
<span class="var-type">mixed</span> |
| 236 |
<span class="var-name">$_temp_dir</span> |
| 237 |
= <span class="var-default"> "/tmp"</span> (line <span class="line-number">43</span>) |
| 238 |
</span> |
| 239 |
</div> |
| 240 |
|
| 241 |
<!-- ========== Info from phpDoc block ========= --> |
| 242 |
<p class="short-description">The place where we temporarily save</p> |
| 243 |
<p class="description"><p>the file during confirmation</p></p> |
| 244 |
|
| 245 |
|
| 246 |
|
| 247 |
|
| 248 |
|
| 249 |
</div> |
| 250 |
<a name="var$_valid_types" id="$_valid_types"><!-- --></A> |
| 251 |
<div class="oddrow"> |
| 252 |
|
| 253 |
<div class="var-header"> |
| 254 |
<span class="var-title"> |
| 255 |
<span class="var-type">mixed</span> |
| 256 |
<span class="var-name">$_valid_types</span> |
| 257 |
= <span class="var-default">array()</span> (line <span class="line-number">49</span>) |
| 258 |
</span> |
| 259 |
</div> |
| 260 |
|
| 261 |
<!-- ========== Info from phpDoc block ========= --> |
| 262 |
<p class="short-description">Array listing mime types to check for</p> |
| 263 |
<p class="description"><p>during validation</p></p> |
| 264 |
|
| 265 |
|
| 266 |
|
| 267 |
|
| 268 |
|
| 269 |
</div> |
| 270 |
|
| 271 |
<h4>Inherited Variables</h4> |
| 272 |
<A NAME='inherited_vars'><!-- --></A> |
| 273 |
<p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p> |
| 274 |
<blockquote> |
| 275 |
<span class="var-title"> |
| 276 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></span><br> |
| 277 |
</span> |
| 278 |
<span class="var-title"> |
| 279 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></span><br> |
| 280 |
</span> |
| 281 |
<span class="var-title"> |
| 282 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_errors">FormElement::$_errors</a></span><br> |
| 283 |
</span> |
| 284 |
<span class="var-title"> |
| 285 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></span><br> |
| 286 |
</span> |
| 287 |
<span class="var-title"> |
| 288 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_form_name">FormElement::$_form_name</a></span><br> |
| 289 |
</span> |
| 290 |
<span class="var-title"> |
| 291 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></span><br> |
| 292 |
</span> |
| 293 |
<span class="var-title"> |
| 294 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_form_on_submit">FormElement::$_has_form_on_submit</a></span><br> |
| 295 |
</span> |
| 296 |
<span class="var-title"> |
| 297 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></span><br> |
| 298 |
</span> |
| 299 |
<span class="var-title"> |
| 300 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></span><br> |
| 301 |
</span> |
| 302 |
<span class="var-title"> |
| 303 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></span><br> |
| 304 |
</span> |
| 305 |
<span class="var-title"> |
| 306 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_required_field_marker">FormElement::$_required_field_marker</a></span><br> |
| 307 |
</span> |
| 308 |
<span class="var-title"> |
| 309 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_slave_elements">FormElement::$_slave_elements</a></span><br> |
| 310 |
</span> |
| 311 |
<span class="var-title"> |
| 312 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_stripslashes">FormElement::$_stripslashes</a></span><br> |
| 313 |
</span> |
| 314 |
<span class="var-title"> |
| 315 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></span><br> |
| 316 |
</span> |
| 317 |
<span class="var-title"> |
| 318 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></span><br> |
| 319 |
</span> |
| 320 |
</blockquote> |
| 321 |
|
| 322 |
</div> |
| 323 |
</div> |
| 324 |
|
| 325 |
<a name="sec-methods"></a> |
| 326 |
<div class="info-box"> |
| 327 |
<div class="info-box-title">Methods</div> |
| 328 |
<div class="nav-bar"> |
| 329 |
<a href="#sec-description">Description</a> | |
| 330 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 331 |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
| 332 |
|
| 333 |
</div> |
| 334 |
<div class="info-box-body"> |
| 335 |
<A NAME='method_detail'></A> |
| 336 |
<a name="methodadd_valid_type" id="add_valid_type"><!-- --></a> |
| 337 |
<div class="evenrow"> |
| 338 |
|
| 339 |
<div class="method-header"> |
| 340 |
<span class="method-title">add_valid_type</span> (line <span class="line-number">286</span>) |
| 341 |
</div> |
| 342 |
|
| 343 |
<!-- ========== Info from phpDoc block ========= --> |
| 344 |
<p class="short-description">This is so the user can create a list of mime types to allow</p> |
| 345 |
|
| 346 |
<div class="method-signature"> |
| 347 |
<span class="method-result">void</span> |
| 348 |
<span class="method-name"> |
| 349 |
add_valid_type |
| 350 |
</span> |
| 351 |
(<span class="var-type">string</span> <span class="var-name">$mime_type</span>) |
| 352 |
</div> |
| 353 |
|
| 354 |
<ul class="parameters"> |
| 355 |
<li> |
| 356 |
<span class="var-type">string</span> |
| 357 |
<span class="var-name">$mime_type</span><span class="var-description">: a mime type to check for</span> </li> |
| 358 |
</ul> |
| 359 |
|
| 360 |
|
| 361 |
</div> |
| 362 |
<a name="methodget_confirm_element" id="get_confirm_element"><!-- --></a> |
| 363 |
<div class="oddrow"> |
| 364 |
|
| 365 |
<div class="method-header"> |
| 366 |
<span class="method-title">get_confirm_element</span> (line <span class="line-number">275</span>) |
| 367 |
</div> |
| 368 |
|
| 369 |
<!-- ========== Info from phpDoc block ========= --> |
| 370 |
<p class="short-description">This method returns the hidden version of this element for a confirmation page.</p> |
| 371 |
<p class="description"><p>NOTE: This is called by the FormProcessor only. It shouldn't be called manually.</p></p> |
| 372 |
<ul class="tags"> |
| 373 |
<li><span class="field">return:</span> of type hidden</li> |
| 374 |
</ul> |
| 375 |
|
| 376 |
<div class="method-signature"> |
| 377 |
<span class="method-result"><a href="../../phpHtmlLib/INPUTtag.html">INPUTtag</a></span> |
| 378 |
<span class="method-name"> |
| 379 |
get_confirm_element |
| 380 |
</span> |
| 381 |
() |
| 382 |
</div> |
| 383 |
|
| 384 |
|
| 385 |
<hr class="separator" /> |
| 386 |
<div class="notes">Redefinition of:</div> |
| 387 |
<dl> |
| 388 |
<dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_confirm_element">FormElement::get_confirm_element()</a></dt> |
| 389 |
<dd>This method returns the hidden version of this element for a confirmation page.</dd> |
| 390 |
</dl> |
| 391 |
|
| 392 |
</div> |
| 393 |
<a name="methodget_element" id="get_element"><!-- --></a> |
| 394 |
<div class="evenrow"> |
| 395 |
|
| 396 |
<div class="method-header"> |
| 397 |
<span class="method-title">get_element</span> (line <span class="line-number">63</span>) |
| 398 |
</div> |
| 399 |
|
| 400 |
<!-- ========== Info from phpDoc block ========= --> |
| 401 |
<p class="short-description">This function builds and returns the form element object</p> |
| 402 |
|
| 403 |
<div class="method-signature"> |
| 404 |
<span class="method-result">object</span> |
| 405 |
<span class="method-name"> |
| 406 |
get_element |
| 407 |
</span> |
| 408 |
() |
| 409 |
</div> |
| 410 |
|
| 411 |
|
| 412 |
<hr class="separator" /> |
| 413 |
<div class="notes">Redefinition of:</div> |
| 414 |
<dl> |
| 415 |
<dt><a href="../../phpHtmlLib/FormProcessing/FEText.html#methodget_element">FEText::get_element()</a></dt> |
| 416 |
<dd>This function builds and returns the form element object</dd> |
| 417 |
</dl> |
| 418 |
|
| 419 |
</div> |
| 420 |
<a name="methodget_file_info" id="get_file_info"><!-- --></a> |
| 421 |
<div class="oddrow"> |
| 422 |
|
| 423 |
<div class="method-header"> |
| 424 |
<span class="method-title">get_file_info</span> (line <span class="line-number">197</span>) |
| 425 |
</div> |
| 426 |
|
| 427 |
<!-- ========== Info from phpDoc block ========= --> |
| 428 |
<p class="short-description">This function will return this file's portion of the $_FILES array</p> |
| 429 |
|
| 430 |
<div class="method-signature"> |
| 431 |
<span class="method-result">array</span> |
| 432 |
<span class="method-name"> |
| 433 |
get_file_info |
| 434 |
</span> |
| 435 |
() |
| 436 |
</div> |
| 437 |
|
| 438 |
|
| 439 |
|
| 440 |
</div> |
| 441 |
<a name="methodget_max_size" id="get_max_size"><!-- --></a> |
| 442 |
<div class="evenrow"> |
| 443 |
|
| 444 |
<div class="method-header"> |
| 445 |
<span class="method-title">get_max_size</span> (line <span class="line-number">305</span>) |
| 446 |
</div> |
| 447 |
|
| 448 |
<!-- ========== Info from phpDoc block ========= --> |
| 449 |
<p class="short-description">This allows the user to get the max size of the file (if any has been set)</p> |
| 450 |
<ul class="tags"> |
| 451 |
<li><span class="field">return:</span> value of $_max_size if any</li> |
| 452 |
</ul> |
| 453 |
|
| 454 |
<div class="method-signature"> |
| 455 |
<span class="method-result">integer</span> |
| 456 |
<span class="method-name"> |
| 457 |
get_max_size |
| 458 |
</span> |
| 459 |
(<span class="var-type">mixed</span> <span class="var-name">$max_size</span>) |
| 460 |
</div> |
| 461 |
|
| 462 |
|
| 463 |
|
| 464 |
</div> |
| 465 |
<a name="methodget_pre_confirm_value" id="get_pre_confirm_value"><!-- --></a> |
| 466 |
<div class="oddrow"> |
| 467 |
|
| 468 |
<div class="method-header"> |
| 469 |
<span class="method-title">get_pre_confirm_value</span> (line <span class="line-number">186</span>) |
| 470 |
</div> |
| 471 |
|
| 472 |
<!-- ========== Info from phpDoc block ========= --> |
| 473 |
<p class="short-description">This is so we can save the file information in a hidden form field during confirmation page.</p> |
| 474 |
|
| 475 |
<div class="method-signature"> |
| 476 |
<span class="method-result">string</span> |
| 477 |
<span class="method-name"> |
| 478 |
get_pre_confirm_value |
| 479 |
</span> |
| 480 |
() |
| 481 |
</div> |
| 482 |
|
| 483 |
|
| 484 |
|
| 485 |
</div> |
| 486 |
<a name="methodget_temp_dir" id="get_temp_dir"><!-- --></a> |
| 487 |
<div class="evenrow"> |
| 488 |
|
| 489 |
<div class="method-header"> |
| 490 |
<span class="method-title">get_temp_dir</span> (line <span class="line-number">219</span>) |
| 491 |
</div> |
| 492 |
|
| 493 |
<!-- ========== Info from phpDoc block ========= --> |
| 494 |
<p class="short-description">This is so the user can get the temp directory where the file was saved during confirmation (if any)</p> |
| 495 |
<ul class="tags"> |
| 496 |
<li><span class="field">return:</span> the new temp dir.</li> |
| 497 |
</ul> |
| 498 |
|
| 499 |
<div class="method-signature"> |
| 500 |
<span class="method-result">string</span> |
| 501 |
<span class="method-name"> |
| 502 |
get_temp_dir |
| 503 |
</span> |
| 504 |
() |
| 505 |
</div> |
| 506 |
|
| 507 |
|
| 508 |
|
| 509 |
</div> |
| 510 |
<a name="methodget_value" id="get_value"><!-- --></a> |
| 511 |
<div class="oddrow"> |
| 512 |
|
| 513 |
<div class="method-header"> |
| 514 |
<span class="method-title">get_value</span> (line <span class="line-number">147</span>) |
| 515 |
</div> |
| 516 |
|
| 517 |
<!-- ========== Info from phpDoc block ========= --> |
| 518 |
<p class="short-description">This function will return the elements value</p> |
| 519 |
|
| 520 |
<div class="method-signature"> |
| 521 |
<span class="method-result">mixed</span> |
| 522 |
<span class="method-name"> |
| 523 |
get_value |
| 524 |
</span> |
| 525 |
() |
| 526 |
</div> |
| 527 |
|
| 528 |
|
| 529 |
<hr class="separator" /> |
| 530 |
<div class="notes">Redefinition of:</div> |
| 531 |
<dl> |
| 532 |
<dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></dt> |
| 533 |
<dd>This function will return the elements value</dd> |
| 534 |
</dl> |
| 535 |
|
| 536 |
</div> |
| 537 |
<a name="methodget_value_text" id="get_value_text"><!-- --></a> |
| 538 |
<div class="evenrow"> |
| 539 |
|
| 540 |
<div class="method-header"> |
| 541 |
<span class="method-title">get_value_text</span> (line <span class="line-number">169</span>) |
| 542 |
</div> |
| 543 |
|
| 544 |
<!-- ========== Info from phpDoc block ========= --> |
| 545 |
<ul class="tags"> |
| 546 |
<li><span class="field">return:</span> - the text associated</li> |
| 547 |
</ul> |
| 548 |
|
| 549 |
<div class="method-signature"> |
| 550 |
<span class="method-result">string</span> |
| 551 |
<span class="method-name"> |
| 552 |
get_value_text |
| 553 |
</span> |
| 554 |
(<span class="var-type">mixed</span> <span class="var-name">0</span>) |
| 555 |
</div> |
| 556 |
|
| 557 |
<ul class="parameters"> |
| 558 |
<li> |
| 559 |
<span class="var-type">mixed</span> |
| 560 |
<span class="var-name">0</span><span class="var-description">: - the value to look up</span> </li> |
| 561 |
</ul> |
| 562 |
|
| 563 |
<hr class="separator" /> |
| 564 |
<div class="notes">Redefinition of:</div> |
| 565 |
<dl> |
| 566 |
<dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></dt> |
| 567 |
<dd>This provides a method</dd> |
| 568 |
</dl> |
| 569 |
|
| 570 |
</div> |
| 571 |
<a name="methodset_max_size" id="set_max_size"><!-- --></a> |
| 572 |
<div class="oddrow"> |
| 573 |
|
| 574 |
<div class="method-header"> |
| 575 |
<span class="method-title">set_max_size</span> (line <span class="line-number">295</span>) |
| 576 |
</div> |
| 577 |
|
| 578 |
<!-- ========== Info from phpDoc block ========= --> |
| 579 |
<p class="short-description">This allows the user to set the max size of the file</p> |
| 580 |
|
| 581 |
<div class="method-signature"> |
| 582 |
<span class="method-result">void</span> |
| 583 |
<span class="method-name"> |
| 584 |
set_max_size |
| 585 |
</span> |
| 586 |
(<span class="var-type">integer</span> <span class="var-name">$max_size</span>) |
| 587 |
</div> |
| 588 |
|
| 589 |
<ul class="parameters"> |
| 590 |
<li> |
| 591 |
<span class="var-type">integer</span> |
| 592 |
<span class="var-name">$max_size</span><span class="var-description">: max size in bytes</span> </li> |
| 593 |
</ul> |
| 594 |
|
| 595 |
|
| 596 |
</div> |
| 597 |
<a name="methodset_temp_dir" id="set_temp_dir"><!-- --></a> |
| 598 |
<div class="evenrow"> |
| 599 |
|
| 600 |
<div class="method-header"> |
| 601 |
<span class="method-title">set_temp_dir</span> (line <span class="line-number">208</span>) |
| 602 |
</div> |
| 603 |
|
| 604 |
<!-- ========== Info from phpDoc block ========= --> |
| 605 |
<p class="short-description">This is so the user can set the temp directory where the file will be saved during confirmation (if any)</p> |
| 606 |
|
| 607 |
<div class="method-signature"> |
| 608 |
<span class="method-result">void</span> |
| 609 |
<span class="method-name"> |
| 610 |
set_temp_dir |
| 611 |
</span> |
| 612 |
(<span class="var-type">string</span> <span class="var-name">$dir</span>) |
| 613 |
</div> |
| 614 |
|
| 615 |
<ul class="parameters"> |
| 616 |
<li> |
| 617 |
<span class="var-type">string</span> |
| 618 |
<span class="var-name">$dir</span><span class="var-description">: the new temp dir.</span> </li> |
| 619 |
</ul> |
| 620 |
|
| 621 |
|
| 622 |
</div> |
| 623 |
<a name="methodvalidate" id="validate"><!-- --></a> |
| 624 |
<div class="oddrow"> |
| 625 |
|
| 626 |
<div class="method-header"> |
| 627 |
<span class="method-title">validate</span> (line <span class="line-number">82</span>) |
| 628 |
</div> |
| 629 |
|
| 630 |
<!-- ========== Info from phpDoc block ========= --> |
| 631 |
<p class="short-description">This method validates the data for this Form Element.</p> |
| 632 |
<p class="description"><p>It validates file size and partial uploads..</p></p> |
| 633 |
|
| 634 |
<div class="method-signature"> |
| 635 |
<span class="method-result">void</span> |
| 636 |
<span class="method-name"> |
| 637 |
validate |
| 638 |
</span> |
| 639 |
(<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span> <span class="var-name">&$_FormValidation</span>) |
| 640 |
</div> |
| 641 |
|
| 642 |
<ul class="parameters"> |
| 643 |
<li> |
| 644 |
<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span> |
| 645 |
<span class="var-name">&$_FormValidation</span><span class="var-description">: object.</span> </li> |
| 646 |
</ul> |
| 647 |
|
| 648 |
<hr class="separator" /> |
| 649 |
<div class="notes">Redefinition of:</div> |
| 650 |
<dl> |
| 651 |
<dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></dt> |
| 652 |
<dd>This function performs the actual validation It is called only if the validation is required by this element</dd> |
| 653 |
</dl> |
| 654 |
|
| 655 |
</div> |
| 656 |
<a name="method_populate_file_info" id="_populate_file_info"><!-- --></a> |
| 657 |
<div class="evenrow"> |
| 658 |
|
| 659 |
<div class="method-header"> |
| 660 |
<span class="method-title">_populate_file_info</span> (line <span class="line-number">259</span>) |
| 661 |
</div> |
| 662 |
|
| 663 |
<!-- ========== Info from phpDoc block ========= --> |
| 664 |
<p class="short-description">This method re-populates the $this->_files_info because the form had a confirmation page, and the user accepted the confirmation.</p> |
| 665 |
<p class="description"><p>This is so we can re populate the local private var so we can get access at the file data on disk.</p></p> |
| 666 |
|
| 667 |
<div class="method-signature"> |
| 668 |
<span class="method-result">void</span> |
| 669 |
<span class="method-name"> |
| 670 |
_populate_file_info |
| 671 |
</span> |
| 672 |
() |
| 673 |
</div> |
| 674 |
|
| 675 |
|
| 676 |
|
| 677 |
</div> |
| 678 |
<a name="method_pre_confirm" id="_pre_confirm"><!-- --></a> |
| 679 |
<div class="oddrow"> |
| 680 |
|
| 681 |
<div class="method-header"> |
| 682 |
<span class="method-title">_pre_confirm</span> (line <span class="line-number">233</span>) |
| 683 |
</div> |
| 684 |
|
| 685 |
<!-- ========== Info from phpDoc block ========= --> |
| 686 |
<p class="short-description">The function that allows us to save the temp file someplace we can use it after a confirmation has been accepted.</p> |
| 687 |
<p class="description"><p>NOTE: if the user doesn't confirm, then this could leave files in /tmp</p></p> |
| 688 |
|
| 689 |
<div class="method-signature"> |
| 690 |
<span class="method-result">void</span> |
| 691 |
<span class="method-name"> |
| 692 |
_pre_confirm |
| 693 |
</span> |
| 694 |
() |
| 695 |
</div> |
| 696 |
|
| 697 |
|
| 698 |
|
| 699 |
</div> |
| 700 |
<h4>Inherited Methods</h4> |
| 701 |
<a name='inherited_methods'><!-- --></a> |
| 702 |
<!-- =========== Summary =========== --> |
| 703 |
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEText.html">FEText</a></span></p> |
| 704 |
<blockquote> |
| 705 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEText.html#methodFEText">FEText::FEText()</a></span><br> |
| 706 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEText.html#methodget_element">FEText::get_element()</a></span><br> |
| 707 |
</blockquote> |
| 708 |
<!-- =========== Summary =========== --> |
| 709 |
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p> |
| 710 |
<blockquote> |
| 711 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></span><br> |
| 712 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></span><br> |
| 713 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodform_tag_onsubmit">FormElement::form_tag_onsubmit()</a></span><br> |
| 714 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></span><br> |
| 715 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_confirm_element">FormElement::get_confirm_element()</a></span><br> |
| 716 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></span><br> |
| 717 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></span><br> |
| 718 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_errors">FormElement::get_errors()</a></span><br> |
| 719 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></span><br> |
| 720 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></span><br> |
| 721 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></span><br> |
| 722 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></span><br> |
| 723 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></span><br> |
| 724 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_slave_elements">FormElement::get_slave_elements()</a></span><br> |
| 725 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_tabindex">FormElement::get_tabindex()</a></span><br> |
| 726 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></span><br> |
| 727 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></span><br> |
| 728 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></span><br> |
| 729 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></span><br> |
| 730 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></span><br> |
| 731 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodjavascript">FormElement::javascript()</a></span><br> |
| 732 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></span><br> |
| 733 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonChange">FormElement::onChange()</a></span><br> |
| 734 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></span><br> |
| 735 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></span><br> |
| 736 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></span><br> |
| 737 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></span><br> |
| 738 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_data_all_slaves">FormElement::set_data_all_slaves()</a></span><br> |
| 739 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></span><br> |
| 740 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_element_name">FormElement::set_element_name()</a></span><br> |
| 741 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></span><br> |
| 742 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_form_name">FormElement::set_form_name()</a></span><br> |
| 743 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></span><br> |
| 744 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></span><br> |
| 745 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required_symbol">FormElement::set_required_symbol()</a></span><br> |
| 746 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_slave_data">FormElement::set_slave_data()</a></span><br> |
| 747 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_slave_elements">FormElement::set_slave_elements()</a></span><br> |
| 748 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_stripslashes">FormElement::set_stripslashes()</a></span><br> |
| 749 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></span><br> |
| 750 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_tabindex">FormElement::set_tabindex()</a></span><br> |
| 751 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></span><br> |
| 752 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></span><br> |
| 753 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></span><br> |
| 754 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></span><br> |
| 755 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></span><br> |
| 756 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></span><br> |
| 757 |
</blockquote> |
| 758 |
|
| 759 |
</div> |
| 760 |
</div> |
| 761 |
|
| 762 |
|
| 763 |
<p class="notes" id="credit"> |
| 764 |
Documentation generated on Thu, 1 Apr 2004 09:38:23 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a> |
| 765 |
</p> |
| 766 |
</div></body> |
| 767 |
</html> |