PHPOpenChat PHP Cross Reference Customer Relationship Management

Source: /doc/apidoc/PHPOpenChat/UploadFile.html - 475 lines - 14001 bytes - Text - Print

   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 UploadFile</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 UploadFile</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  20                          |                                            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  21                          
  22              </div>
  23      <div class="info-box-body">
  24          <!-- ========== Info from phpDoc block ========= -->
  25  <p class="short-description">Upload class - wrapper for uploading files.</p>
  26      <ul class="tags">
  27                  <li><span class="field">version:</span> $Id: class.UploadFile.inc,v 1.4 2002/12/03 13:16:57 letreo Exp $</li>
  28                  <li><span class="field">access:</span> public</li>
  29                  <li><span class="field">author:</span> Michael Oertel &lt;<a href="mailto:michael@ortelius.de">michael@ortelius.de</a>&gt;</li>
  30              </ul>
  31          <p class="notes">
  32              Located in <a class="field" href="_include_class_UploadFile_inc.html">Program_Root/include/class.UploadFile.inc</a> (line <span class="field">36</span>)
  33          </p>
  34          
  35                  
  36          <pre></pre>
  37      
  38              </div>
  39  </div>
  40  
  41  
  42      <a name="sec-var-summary"></a>
  43      <div class="info-box">
  44          <div class="info-box-title">Variable Summary</span></div>
  45          <div class="nav-bar">
  46              <a href="#sec-description">Description</a> |
  47                          <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  48                              | 
  49                                      <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  50                              
  51                      </div>
  52          <div class="info-box-body">
  53              <div class="var-summary">
  54                                  <div class="var-title">
  55                      <span class="var-type">array</span>
  56                      <a href="#$errors" title="details" class="var-name">$errors</a>
  57                  </div>
  58                                  <div class="var-title">
  59                      <span class="var-type">array</span>
  60                      <a href="#$file_attributes" title="details" class="var-name">$file_attributes</a>
  61                  </div>
  62                                  <div class="var-title">
  63                      <span class="var-type">string</span>
  64                      <a href="#$path" title="details" class="var-name">$path</a>
  65                  </div>
  66                                  <div class="var-title">
  67                      <span class="var-type">integer</span>
  68                      <a href="#$size_bytes" title="details" class="var-name">$size_bytes</a>
  69                  </div>
  70                                  <div class="var-title">
  71                      <span class="var-type">integer</span>
  72                      <a href="#$size_x" title="details" class="var-name">$size_x</a>
  73                  </div>
  74                                  <div class="var-title">
  75                      <span class="var-type">integer</span>
  76                      <a href="#$size_y" title="details" class="var-name">$size_y</a>
  77                  </div>
  78                                  <div class="var-title">
  79                      <span class="var-type">array</span>
  80                      <a href="#$types" title="details" class="var-name">$types</a>
  81                  </div>
  82                              </div>
  83          </div>
  84      </div>
  85  
  86      <a name="sec-method-summary"></a>
  87      <div class="info-box">
  88          <div class="info-box-title">Method Summary</span></div>
  89          <div class="nav-bar">
  90              <a href="#sec-description">Description</a> |
  91                                                              <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  92                   
  93                  |
  94                          <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  95          </div>
  96          <div class="info-box-body">            
  97              <div class="method-summary">
  98                                  
  99                  <div class="method-definition">
 100                                              <span class="method-result">void</span>
 101                                          <a href="#UploadFile" title="details" class="method-name">UploadFile</a>
 102                                              (<span class="var-type">array</span>&nbsp;<span class="var-name">$file_attributes</span>)
 103                                      </div>
 104                                  
 105                  <div class="method-definition">
 106                                              <span class="method-result">boolean</span>
 107                                          <a href="#check" title="details" class="method-name">check</a>
 108                                              (<span class="var-type">array</span>&nbsp;<span class="var-name">0</span>)
 109                                      </div>
 110                                  
 111                  <div class="method-definition">
 112                                              <span class="method-result">array</span>
 113                                          <a href="#get_errors" title="details" class="method-name">get_errors</a>
 114                                          ()
 115                                      </div>
 116                                  
 117                  <div class="method-definition">
 118                                              <span class="method-result">string</span>
 119                                          <a href="#get_upload_path" title="details" class="method-name">get_upload_path</a>
 120                                          ()
 121                                      </div>
 122                                  
 123                  <div class="method-definition">
 124                                              <span class="method-result">void</span>
 125                                          <a href="#set_types" title="details" class="method-name">set_types</a>
 126                                              (<span class="var-type">array</span>&nbsp;<span class="var-name">$types</span>)
 127                                      </div>
 128                                  
 129                  <div class="method-definition">
 130                                              <span class="method-result">string</span>
 131                                          <a href="#set_upload_path" title="details" class="method-name">set_upload_path</a>
 132                                              (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$path</span>)
 133                                      </div>
 134                                  
 135                  <div class="method-definition">
 136                                              <span class="method-result">boolean</span>
 137                                          <a href="#upload" title="details" class="method-name">upload</a>
 138                                              ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$mode</span> = <span class="var-default">1</span>])
 139                                      </div>
 140                              </div>
 141          </div>
 142      </div>        
 143  
 144      <a name="sec-vars"></a>
 145      <div class="info-box">
 146          <div class="info-box-title">Variables</div>
 147          <div class="nav-bar">
 148              <a href="#sec-description">Description</a> |
 149                                          <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
 150                          
 151              
 152                              | 
 153                                      <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
 154                              
 155                      </div>
 156          <div class="info-box-body">
 157              <a name="var$errors" id="$errors"><!-- --></A>
 158  <div class="oddrow">
 159  
 160      <div class="var-header">
 161          <span class="var-title">
 162              <span class="var-type">array</span>
 163              <span class="var-name">$errors</span>
 164               = <span class="var-default">array()</span>            (line <span class="line-number">78</span>)
 165          </span>
 166      </div>
 167  
 168      <!-- ========== Info from phpDoc block ========= -->
 169  <p class="short-description">Contains upload errors</p>
 170      
 171      
 172          
 173          
 174  
 175  </div>
 176  <a name="var$file_attributes" id="$file_attributes"><!-- --></A>
 177  <div class="evenrow">
 178  
 179      <div class="var-header">
 180          <span class="var-title">
 181              <span class="var-type">array</span>
 182              <span class="var-name">$file_attributes</span>
 183               = <span class="var-default">array()</span>            (line <span class="line-number">43</span>)
 184          </span>
 185      </div>
 186  
 187      <!-- ========== Info from phpDoc block ========= -->
 188  <p class="short-description">Contains all file attributes</p>
 189      
 190      
 191          
 192          
 193  
 194  </div>
 195  <a name="var$path" id="$path"><!-- --></A>
 196  <div class="oddrow">
 197  
 198      <div class="var-header">
 199          <span class="var-title">
 200              <span class="var-type">string</span>
 201              <span class="var-name">$path</span>
 202                          (line <span class="line-number">85</span>)
 203          </span>
 204      </div>
 205  
 206      <!-- ========== Info from phpDoc block ========= -->
 207  <p class="short-description">Contains upload path</p>
 208      
 209      
 210          
 211          
 212  
 213  </div>
 214  <a name="var$size_bytes" id="$size_bytes"><!-- --></A>
 215  <div class="evenrow">
 216  
 217      <div class="var-header">
 218          <span class="var-title">
 219              <span class="var-type">integer</span>
 220              <span class="var-name">$size_bytes</span>
 221               = <span class="var-default">PRIVATE_IMG_MAX_BYTES</span>            (line <span class="line-number">71</span>)
 222          </span>
 223      </div>
 224  
 225      <!-- ========== Info from phpDoc block ========= -->
 226  <p class="short-description">Image size in bytes</p>
 227      
 228      
 229          
 230          
 231  
 232  </div>
 233  <a name="var$size_x" id="$size_x"><!-- --></A>
 234  <div class="oddrow">
 235  
 236      <div class="var-header">
 237          <span class="var-title">
 238              <span class="var-type">integer</span>
 239              <span class="var-name">$size_x</span>
 240               = <span class="var-default">PRIVATE_IMG_SIZE_X</span>            (line <span class="line-number">57</span>)
 241          </span>
 242      </div>
 243  
 244      <!-- ========== Info from phpDoc block ========= -->
 245  <p class="short-description">Image size in pixels</p>
 246      
 247      
 248          
 249          
 250  
 251  </div>
 252  <a name="var$size_y" id="$size_y"><!-- --></A>
 253  <div class="evenrow">
 254  
 255      <div class="var-header">
 256          <span class="var-title">
 257              <span class="var-type">integer</span>
 258              <span class="var-name">$size_y</span>
 259               = <span class="var-default">PRIVATE_IMG_SIZE_Y</span>            (line <span class="line-number">64</span>)
 260          </span>
 261      </div>
 262  
 263      <!-- ========== Info from phpDoc block ========= -->
 264  <p class="short-description">Image size in pixels</p>
 265      
 266      
 267          
 268          
 269  
 270  </div>
 271  <a name="var$types" id="$types"><!-- --></A>
 272  <div class="oddrow">
 273  
 274      <div class="var-header">
 275          <span class="var-title">
 276              <span class="var-type">array</span>
 277              <span class="var-name">$types</span>
 278               = <span class="var-default">array()</span>            (line <span class="line-number">50</span>)
 279          </span>
 280      </div>
 281  
 282      <!-- ========== Info from phpDoc block ========= -->
 283  <p class="short-description">Expected mime types</p>
 284      
 285      
 286          
 287          
 288  
 289  </div>
 290                          
 291          </div>
 292      </div>
 293      
 294      <a name="sec-methods"></a>
 295      <div class="info-box">
 296          <div class="info-box-title">Methods</div>
 297          <div class="nav-bar">
 298              <a href="#sec-description">Description</a> |
 299                                                              <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
 300                                                          <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 301                          
 302          </div>
 303          <div class="info-box-body">
 304              <A NAME='method_detail'></A>
 305  <a name="methodUploadFile" id="UploadFile"><!-- --></a>
 306  <div class="evenrow">
 307      
 308      <div class="method-header">
 309          <span class="method-title">Constructor UploadFile</span> (line <span class="line-number">92</span>)
 310      </div> 
 311      
 312      <!-- ========== Info from phpDoc block ========= -->
 313  <p class="short-description">Constructor</p>
 314      
 315      <div class="method-signature">
 316          <span class="method-result">void</span>
 317          <span class="method-name">
 318              UploadFile
 319          </span>
 320                      (<span class="var-type">array</span>&nbsp;<span class="var-name">$file_attributes</span>)
 321              </div>
 322      
 323              <ul class="parameters">
 324                      <li>
 325                  <span class="var-type">array</span>
 326                  <span class="var-name">$file_attributes</span>            </li>
 327                  </ul>
 328          
 329          
 330      </div>
 331  <a name="methodcheck" id="check"><!-- --></a>
 332  <div class="oddrow">
 333      
 334      <div class="method-header">
 335          <span class="method-title">check</span> (line <span class="line-number">143</span>)
 336      </div> 
 337      
 338      <!-- ========== Info from phpDoc block ========= -->
 339  <p class="short-description">Checks the posted file</p>
 340      
 341      <div class="method-signature">
 342          <span class="method-result">boolean</span>
 343          <span class="method-name">
 344              check
 345          </span>
 346                      (<span class="var-type">array</span>&nbsp;<span class="var-name">0</span>)
 347              </div>
 348      
 349              <ul class="parameters">
 350                      <li>
 351                  <span class="var-type">array</span>
 352                  <span class="var-name">0</span>            </li>
 353                  </ul>
 354          
 355          
 356      </div>
 357  <a name="methodget_errors" id="get_errors"><!-- --></a>
 358  <div class="evenrow">
 359      
 360      <div class="method-header">
 361          <span class="method-title">get_errors</span> (line <span class="line-number">112</span>)
 362      </div> 
 363      
 364      <!-- ========== Info from phpDoc block ========= -->
 365  <p class="short-description">Gets all upload errors</p>
 366      
 367      <div class="method-signature">
 368          <span class="method-result">array</span>
 369          <span class="method-name">
 370              get_errors
 371          </span>
 372                  ()
 373              </div>
 374      
 375          
 376          
 377      </div>
 378  <a name="methodget_upload_path" id="get_upload_path"><!-- --></a>
 379  <div class="oddrow">
 380      
 381      <div class="method-header">
 382          <span class="method-title">get_upload_path</span> (line <span class="line-number">122</span>)
 383      </div> 
 384      
 385      <!-- ========== Info from phpDoc block ========= -->
 386  <p class="short-description">Gets upload path</p>
 387      
 388      <div class="method-signature">
 389          <span class="method-result">string</span>
 390          <span class="method-name">
 391              get_upload_path
 392          </span>
 393                  ()
 394              </div>
 395      
 396          
 397          
 398      </div>
 399  <a name="methodset_types" id="set_types"><!-- --></a>
 400  <div class="evenrow">
 401      
 402      <div class="method-header">
 403          <span class="method-title">set_types</span> (line <span class="line-number">102</span>)
 404      </div> 
 405      
 406      <!-- ========== Info from phpDoc block ========= -->
 407  <p class="short-description">Sets expected mime types</p>
 408      
 409      <div class="method-signature">
 410          <span class="method-result">void</span>
 411          <span class="method-name">
 412              set_types
 413          </span>
 414                      (<span class="var-type">array</span>&nbsp;<span class="var-name">$types</span>)
 415              </div>
 416      
 417              <ul class="parameters">
 418                      <li>
 419                  <span class="var-type">array</span>
 420                  <span class="var-name">$types</span>            </li>
 421                  </ul>
 422          
 423          
 424      </div>
 425  <a name="methodset_upload_path" id="set_upload_path"><!-- --></a>
 426  <div class="oddrow">
 427      
 428      <div class="method-header">
 429          <span class="method-title">set_upload_path</span> (line <span class="line-number">132</span>)
 430      </div> 
 431      
 432      <!-- ========== Info from phpDoc block ========= -->
 433  <p class="short-description">Gets upload path</p>
 434      
 435      <div class="method-signature">
 436          <span class="method-result">string</span>
 437          <span class="method-name">
 438              set_upload_path
 439          </span>
 440                      (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$path</span>)
 441              </div>
 442      
 443          
 444          
 445      </div>
 446  <a name="methodupload" id="upload"><!-- --></a>
 447  <div class="evenrow">
 448      
 449      <div class="method-header">
 450          <span class="method-title">upload</span> (line <span class="line-number">163</span>)
 451      </div> 
 452      
 453      <!-- ========== Info from phpDoc block ========= -->
 454  <p class="short-description">Uploads the file</p>
 455      
 456      <div class="method-signature">
 457          <span class="method-result">boolean</span>
 458          <span class="method-name">
 459              upload
 460          </span>
 461                      ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$mode</span> = <span class="var-default">1</span>])
 462              </div>
 463      
 464          
 465          
 466      </div>
 467                          
 468          </div>
 469      </div>
 470      
 471      <p class="notes" id="credit">
 472          Documention generated on Fri,  2 May 2003 10:50:48 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc2</a>
 473      </p>
 474      </div></body>
 475  </html>

title

Description

title

Description

title

Description

title

title

Body