[Sommaire] [Imprimer]

   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 THttpResponse</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 THttpResponse</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-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  20                          
  21                      </div>
  22      <div class="info-box-body">
  23                  <p class="implements">
  24              Implements interfaces:
  25              <ul>
  26                  <li><a href="../System/ITextWriter.html">ITextWriter</a></li>            </ul>
  27          </p>
  28                  <!-- ========== Info from phpDoc block ========= -->
  29  <p class="short-description">THttpResponse class</p>
  30  <p class="description"><p>THttpResponse implements the mechanism for sending output to client users.</p><p>To output a string to client, use <a href="../System.Web/THttpResponse.html#methodwrite">write()</a>. By default, the output is  buffered until <a href="../System.Web/THttpResponse.html#methodflush">flush()</a> is called or the application ends. The output in  the buffer can also be cleaned by <a href="../System.Web/THttpResponse.html#methodclear">clear()</a>. To disable output buffering,  set BufferOutput property to false.</p><p>To send cookies to client, use <a href="../System.Web/THttpResponse.html#methodgetCookies">getCookies()</a>.  To redirect client browser to a new URL, use <a href="../System.Web/THttpResponse.html#methodredirect">redirect()</a>.  To send a file to client, use <a href="../System.Web/THttpResponse.html#methodwriteFile">writeFile()</a>.</p><p>By default, THttpResponse is registered with <a href="../System/TApplication.html">TApplication</a> as the  response module. It can be accessed via <a href="../System/TApplication.html#methodgetResponse">TApplication::getResponse()</a>.</p><p>THttpResponse may be configured in application configuration file as follows</p><p>&lt;module id=&quot;response&quot; CacheExpire=&quot;20&quot; CacheControl=&quot;nocache&quot; BufferOutput=&quot;true&quot; /&gt;</p><p>where <a href="../System.Web/THttpResponse.html#methodgetCacheExpire">CacheExpire</a>, <a href="../System.Web/THttpResponse.html#methodgetCacheControl">CacheControl</a>  and <a href="../System.Web/THttpResponse.html#methodgetBufferOutput">BufferOutput</a> are optional properties of THttpResponse.</p><p>THttpResponse sends charset header if either <a href="../System.Web/THttpResponse.html#methodsetCharset">Charset</a>  or <a href="../System.I18N/TGlobalization.html#methodsetCharset">TGlobalization.Charset</a> is set.</p></p>
  31      <ul class="tags">
  32                  <li><span class="field">since:</span> 3.0</li>
  33                  <li><span class="field">version:</span> $Id: THttpResponse.php 1508 2006-11-25 20:42:54Z xue $</li>
  34                  <li><span class="field">author:</span> Qiang Xue &lt;<a href="mailto:qiang.xue@gmail.com">qiang.xue@gmail.com</a>&gt;</li>
  35              </ul>
  36          <p class="notes">
  37              Located in <a class="field" href="_Web_THttpResponse_php.html">/Web/THttpResponse.php</a> (line <span class="field">45</span>)
  38          </p>
  39          
  40                  
  41          <pre><a href="../System/TComponent.html">TComponent</a>
  42     |
  43     --<a href="../System/TApplicationComponent.html">TApplicationComponent</a>
  44        |
  45        --<a href="../System/TModule.html">TModule</a>
  46           |
  47           --THttpResponse</pre>
  48      
  49              </div>
  50  </div>
  51  
  52  
  53  
  54  
  55      <a name="sec-method-summary"></a>
  56      <div class="info-box">
  57          <div class="info-box-title">Method Summary</span></div>
  58          <div class="nav-bar">
  59              <a href="#sec-description">Description</a> |
  60                                                  <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  61          </div>
  62          <div class="info-box-body">            
  63              <div class="method-summary">
  64                                  
  65                  <div class="method-definition">
  66                                              <span class="method-result">void</span>
  67                                          <a href="#__destruct" title="details" class="method-name">__destruct</a>
  68                                          ()
  69                                      </div>
  70                                  
  71                  <div class="method-definition">
  72                                              <span class="method-result">void</span>
  73                                          <a href="#addCookie" title="details" class="method-name">addCookie</a>
  74                                              (<span class="var-type"><a href="../System.Web/THttpCookie.html">THttpCookie</a></span>&nbsp;<span class="var-name">$cookie</span>)
  75                                      </div>
  76                                  
  77                  <div class="method-definition">
  78                                              <span class="method-result">void</span>
  79                                          <a href="#appendHeader" title="details" class="method-name">appendHeader</a>
  80                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
  81                                      </div>
  82                                  
  83                  <div class="method-definition">
  84                                              <span class="method-result">void</span>
  85                                          <a href="#appendLog" title="details" class="method-name">appendLog</a>
  86                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$messageType</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$destination</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$extraHeaders</span> = <span class="var-default">''</span>])
  87                                      </div>
  88                                  
  89                  <div class="method-definition">
  90                                              <span class="method-result">void</span>
  91                                          <a href="#clear" title="details" class="method-name">clear</a>
  92                                          ()
  93                                      </div>
  94                                  
  95                  <div class="method-definition">
  96                                              <span class="method-result">void</span>
  97                                          <a href="#createHtmlWriter" title="details" class="method-name">createHtmlWriter</a>
  98                                              ([<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
  99                                      </div>
 100                                  
 101                  <div class="method-definition">
 102                                              <span class="method-result">void</span>
 103                                          <a href="#flush" title="details" class="method-name">flush</a>
 104                                          ()
 105                                      </div>
 106                                  
 107                  <div class="method-definition">
 108                                              <span class="method-result">boolean</span>
 109                                          <a href="#getBufferOutput" title="details" class="method-name">getBufferOutput</a>
 110                                          ()
 111                                      </div>
 112                                  
 113                  <div class="method-definition">
 114                                              <span class="method-result">string</span>
 115                                          <a href="#getCacheControl" title="details" class="method-name">getCacheControl</a>
 116                                          ()
 117                                      </div>
 118                                  
 119                  <div class="method-definition">
 120                                              <span class="method-result">integer</span>
 121                                          <a href="#getCacheExpire" title="details" class="method-name">getCacheExpire</a>
 122                                          ()
 123                                      </div>
 124                                  
 125                  <div class="method-definition">
 126                                              <span class="method-result">string</span>
 127                                          <a href="#getCharset" title="details" class="method-name">getCharset</a>
 128                                          ()
 129                                      </div>
 130                                  
 131                  <div class="method-definition">
 132                                              <span class="method-result">string</span>
 133                                          <a href="#getContents" title="details" class="method-name">getContents</a>
 134                                          ()
 135                                      </div>
 136                                  
 137                  <div class="method-definition">
 138                                              <span class="method-result">string</span>
 139                                          <a href="#getContentType" title="details" class="method-name">getContentType</a>
 140                                          ()
 141                                      </div>
 142                                  
 143                  <div class="method-definition">
 144                                              <span class="method-result"><a href="../System.Web/THttpCookieCollection.html">THttpCookieCollection</a></span>
 145                                          <a href="#getCookies" title="details" class="method-name">getCookies</a>
 146                                          ()
 147                                      </div>
 148                                  
 149                  <div class="method-definition">
 150                                              <span class="method-result">string</span>
 151                                          <a href="#getHtmlWriterType" title="details" class="method-name">getHtmlWriterType</a>
 152                                          ()
 153                                      </div>
 154                                  
 155                  <div class="method-definition">
 156                                              <span class="method-result">integer</span>
 157                                          <a href="#getStatusCode" title="details" class="method-name">getStatusCode</a>
 158                                          ()
 159                                      </div>
 160                                  
 161                  <div class="method-definition">
 162                                              <span class="method-result">void</span>
 163                                          <a href="#init" title="details" class="method-name">init</a>
 164                                              (<span class="var-type"><a href="../System.Xml/TXmlElement.html">TXmlElement</a></span>&nbsp;<span class="var-name">$config</span>)
 165                                      </div>
 166                                  
 167                  <div class="method-definition">
 168                                              <span class="method-result">void</span>
 169                                          <a href="#redirect" title="details" class="method-name">redirect</a>
 170                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
 171                                      </div>
 172                                  
 173                  <div class="method-definition">
 174                                              <span class="method-result">void</span>
 175                                          <a href="#reload" title="details" class="method-name">reload</a>
 176                                          ()
 177                                      </div>
 178                                  
 179                  <div class="method-definition">
 180                                              <span class="method-result">void</span>
 181                                          <a href="#removeCookie" title="details" class="method-name">removeCookie</a>
 182                                              (<span class="var-type"><a href="../System.Web/THttpCookie.html">THttpCookie</a></span>&nbsp;<span class="var-name">$cookie</span>)
 183                                      </div>
 184                                  
 185                  <div class="method-definition">
 186                                              <span class="method-result">void</span>
 187                                          <a href="#sendContentTypeHeader" title="details" class="method-name">sendContentTypeHeader</a>
 188                                          ()
 189                                      </div>
 190                                  
 191                  <div class="method-definition">
 192                                              <span class="method-result">void</span>
 193                                          <a href="#setBufferOutput" title="details" class="method-name">setBufferOutput</a>
 194                                              (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$value</span>)
 195                                      </div>
 196                                  
 197                  <div class="method-definition">
 198                                              <span class="method-result">void</span>
 199                                          <a href="#setCacheControl" title="details" class="method-name">setCacheControl</a>
 200                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 201                                      </div>
 202                                  
 203                  <div class="method-definition">
 204                                              <span class="method-result">void</span>
 205                                          <a href="#setCacheExpire" title="details" class="method-name">setCacheExpire</a>
 206                                              (<span class="var-type">integer</span>&nbsp;<span class="var-name">$value</span>)
 207                                      </div>
 208                                  
 209                  <div class="method-definition">
 210                                              <span class="method-result">void</span>
 211                                          <a href="#setCharset" title="details" class="method-name">setCharset</a>
 212                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$charset</span>)
 213                                      </div>
 214                                  
 215                  <div class="method-definition">
 216                                              <span class="method-result">string</span>
 217                                          <a href="#setContentType" title="details" class="method-name">setContentType</a>
 218                                              (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$type</span>)
 219                                      </div>
 220                                  
 221                  <div class="method-definition">
 222                                              <span class="method-result">void</span>
 223                                          <a href="#setHtmlWriterType" title="details" class="method-name">setHtmlWriterType</a>
 224                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 225                                      </div>
 226                                  
 227                  <div class="method-definition">
 228                                              <span class="method-result">void</span>
 229                                          <a href="#setStatusCode" title="details" class="method-name">setStatusCode</a>
 230                                              (<span class="var-type">integer</span>&nbsp;<span class="var-name">$status</span>)
 231                                      </div>
 232                                  
 233                  <div class="method-definition">
 234                                              <span class="method-result">void</span>
 235                                          <a href="#write" title="details" class="method-name">write</a>
 236                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$str</span>)
 237                                      </div>
 238                                  
 239                  <div class="method-definition">
 240                                              <span class="method-result">void</span>
 241                                          <a href="#writeFile" title="details" class="method-name">writeFile</a>
 242                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$fileName</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$content</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$mimeType</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$headers</span> = <span class="var-default">null</span>])
 243                                      </div>
 244                              </div>
 245          </div>
 246      </div>        
 247  
 248      
 249      <a name="sec-methods"></a>
 250      <div class="info-box">
 251          <div class="info-box-title">Methods</div>
 252          <div class="nav-bar">
 253              <a href="#sec-description">Description</a> |
 254                                                                  <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 255                          
 256          </div>
 257          <div class="info-box-body">
 258              <A NAME='method_detail'></A>
 259  <a name="method__destruct" id="__destruct"><!-- --></a>
 260  <div class="oddrow">
 261      
 262      <div class="method-header">
 263          <span class="method-title">Destructor __destruct</span> (line <span class="line-number">80</span>)
 264      </div> 
 265      
 266      <!-- ========== Info from phpDoc block ========= -->
 267  <p class="short-description">Destructor.</p>
 268  <p class="description"><p>Flushes any existing content in buffer.</p></p>
 269      <ul class="tags">
 270                  <li><span class="field">access:</span> public</li>
 271              </ul>
 272      
 273      <div class="method-signature">
 274          <span class="method-result">void</span>
 275          <span class="method-name">
 276              __destruct
 277          </span>
 278                  ()
 279              </div>
 280      
 281          
 282          
 283      </div>
 284  <a name="methodaddCookie" id="addCookie"><!-- --></a>
 285  <div class="evenrow">
 286      
 287      <div class="method-header">
 288          <span class="method-title">addCookie</span> (line <span class="line-number">381</span>)
 289      </div> 
 290      
 291      <!-- ========== Info from phpDoc block ========= -->
 292  <p class="short-description">Sends a cookie.</p>
 293  <p class="description"><p>Do not call this method directly. Operate with the result of <a href="../System.Web/THttpResponse.html#methodgetCookies">getCookies</a> instead.</p></p>
 294      <ul class="tags">
 295                  <li><span class="field">access:</span> public</li>
 296              </ul>
 297      
 298      <div class="method-signature">
 299          <span class="method-result">void</span>
 300          <span class="method-name">
 301              addCookie
 302          </span>
 303                      (<span class="var-type"><a href="../System.Web/THttpCookie.html">THttpCookie</a></span>&nbsp;<span class="var-name">$cookie</span>)
 304              </div>
 305      
 306              <ul class="parameters">
 307                      <li>
 308                  <span class="var-type"><a href="../System.Web/THttpCookie.html">THttpCookie</a></span>
 309                  <span class="var-name">$cookie</span><span class="var-description">: cook to be sent</span>            </li>
 310                  </ul>
 311          
 312          
 313      </div>
 314  <a name="methodappendHeader" id="appendHeader"><!-- --></a>
 315  <div class="oddrow">
 316      
 317      <div class="method-header">
 318          <span class="method-title">appendHeader</span> (line <span class="line-number">356</span>)
 319      </div> 
 320      
 321      <!-- ========== Info from phpDoc block ========= -->
 322  <p class="short-description">Sends a header.</p>
 323      <ul class="tags">
 324                  <li><span class="field">access:</span> public</li>
 325              </ul>
 326      
 327      <div class="method-signature">
 328          <span class="method-result">void</span>
 329          <span class="method-name">
 330              appendHeader
 331          </span>
 332                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 333              </div>
 334      
 335              <ul class="parameters">
 336                      <li>
 337                  <span class="var-type">string</span>
 338                  <span class="var-name">$value</span><span class="var-description">: header</span>            </li>
 339                  </ul>
 340          
 341          
 342      </div>
 343  <a name="methodappendLog" id="appendLog"><!-- --></a>
 344  <div class="evenrow">
 345      
 346      <div class="method-header">
 347          <span class="method-title">appendLog</span> (line <span class="line-number">371</span>)
 348      </div> 
 349      
 350      <!-- ========== Info from phpDoc block ========= -->
 351  <p class="short-description">Writes a log message into error log.</p>
 352  <p class="description"><p>This method is simple wrapper of PHP function error_log.</p></p>
 353      <ul class="tags">
 354                  <li><span class="field">access:</span> public</li>
 355                  <li><span class="field">see:</span> <a href="http://us2.php.net/manual/en/function.error-log.php">http://us2.php.net/manual/en/function.error-log.php</a></li>
 356              </ul>
 357      
 358      <div class="method-signature">
 359          <span class="method-result">void</span>
 360          <span class="method-name">
 361              appendLog
 362          </span>
 363                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$messageType</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$destination</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$extraHeaders</span> = <span class="var-default">''</span>])
 364              </div>
 365      
 366              <ul class="parameters">
 367                      <li>
 368                  <span class="var-type">string</span>
 369                  <span class="var-name">$message</span><span class="var-description">: The error message that should be logged</span>            </li>
 370                      <li>
 371                  <span class="var-type">integer</span>
 372                  <span class="var-name">$messageType</span><span class="var-description">: where the error should go</span>            </li>
 373                      <li>
 374                  <span class="var-type">string</span>
 375                  <span class="var-name">$destination</span><span class="var-description">: The destination. Its meaning depends on the message parameter as described above</span>            </li>
 376                      <li>
 377                  <span class="var-type">string</span>
 378                  <span class="var-name">$extraHeaders</span><span class="var-description">: The extra headers. It's used when the message parameter is set to 1. This message type uses the same internal function as mail() does.</span>            </li>
 379                  </ul>
 380          
 381          
 382      </div>
 383  <a name="methodclear" id="clear"><!-- --></a>
 384  <div class="oddrow">
 385      
 386      <div class="method-header">
 387          <span class="method-title">clear</span> (line <span class="line-number">345</span>)
 388      </div> 
 389      
 390      <!-- ========== Info from phpDoc block ========= -->
 391  <p class="short-description">Clears any existing buffered content.</p>
 392      <ul class="tags">
 393                  <li><span class="field">access:</span> public</li>
 394              </ul>
 395      
 396      <div class="method-signature">
 397          <span class="method-result">void</span>
 398          <span class="method-name">
 399              clear
 400          </span>
 401                  ()
 402              </div>
 403      
 404          
 405          
 406      </div>
 407  <a name="methodcreateHtmlWriter" id="createHtmlWriter"><!-- --></a>
 408  <div class="evenrow">
 409      
 410      <div class="method-header">
 411          <span class="method-title">createHtmlWriter</span> (line <span class="line-number">424</span>)
 412      </div> 
 413      
 414      <!-- ========== Info from phpDoc block ========= -->
 415  <p class="short-description">Creates a new instance of HTML writer.</p>
 416  <p class="description"><p>If the type of the HTML writer is not supplied, <a href="../System.Web/THttpResponse.html#methodgetHtmlWriterType">HtmlWriterType</a> will be assumed.</p></p>
 417      <ul class="tags">
 418                  <li><span class="field">access:</span> public</li>
 419              </ul>
 420      
 421      <div class="method-signature">
 422          <span class="method-result">void</span>
 423          <span class="method-name">
 424              createHtmlWriter
 425          </span>
 426                      ([<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
 427              </div>
 428      
 429              <ul class="parameters">
 430                      <li>
 431                  <span class="var-type">string</span>
 432                  <span class="var-name">$type</span><span class="var-description">: type of the HTML writer to be created. If null, <a href="../System.Web/THttpResponse.html#methodgetHtmlWriterType">HtmlWriterType</a> will be assumed.</span>            </li>
 433                  </ul>
 434          
 435          
 436      </div>
 437  <a name="methodflush" id="flush"><!-- --></a>
 438  <div class="oddrow">
 439      
 440      <div class="method-header">
 441          <span class="method-title">flush</span> (line <span class="line-number">305</span>)
 442      </div> 
 443      
 444      <!-- ========== Info from phpDoc block ========= -->
 445  <p class="short-description">Outputs the buffered content, sends content-type and charset header.</p>
 446      <ul class="tags">
 447                  <li><span class="field">access:</span> public</li>
 448              </ul>
 449      
 450      <div class="method-signature">
 451          <span class="method-result">void</span>
 452          <span class="method-name">
 453              flush
 454          </span>
 455                  ()
 456              </div>
 457      
 458          
 459          
 460      </div>
 461  <a name="methodgetBufferOutput" id="getBufferOutput"><!-- --></a>
 462  <div class="evenrow">
 463      
 464      <div class="method-header">
 465          <span class="method-title">getBufferOutput</span> (line <span class="line-number">168</span>)
 466      </div> 
 467      
 468      <!-- ========== Info from phpDoc block ========= -->
 469      <ul class="tags">
 470                  <li><span class="field">return:</span> whether to enable output buffer</li>
 471                  <li><span class="field">access:</span> public</li>
 472              </ul>
 473      
 474      <div class="method-signature">
 475          <span class="method-result">boolean</span>
 476          <span class="method-name">
 477              getBufferOutput
 478          </span>
 479                  ()
 480              </div>
 481      
 482          
 483          
 484      </div>
 485  <a name="methodgetCacheControl" id="getCacheControl"><!-- --></a>
 486  <div class="oddrow">
 487      
 488      <div class="method-header">
 489          <span class="method-title">getCacheControl</span> (line <span class="line-number">119</span>)
 490      </div> 
 491      
 492      <!-- ========== Info from phpDoc block ========= -->
 493      <ul class="tags">
 494                  <li><span class="field">return:</span> cache control method to use for session pages</li>
 495                  <li><span class="field">access:</span> public</li>
 496              </ul>
 497      
 498      <div class="method-signature">
 499          <span class="method-result">string</span>
 500          <span class="method-name">
 501              getCacheControl
 502          </span>
 503                  ()
 504              </div>
 505      
 506          
 507          
 508      </div>
 509  <a name="methodgetCacheExpire" id="getCacheExpire"><!-- --></a>
 510  <div class="evenrow">
 511      
 512      <div class="method-header">
 513          <span class="method-title">getCacheExpire</span> (line <span class="line-number">103</span>)
 514      </div> 
 515      
 516      <!-- ========== Info from phpDoc block ========= -->
 517      <ul class="tags">
 518                  <li><span class="field">return:</span> time-to-live for cached session pages in minutes, this has no effect for nocache limiter. Defaults to 180.</li>
 519                  <li><span class="field">access:</span> public</li>
 520              </ul>
 521      
 522      <div class="method-signature">
 523          <span class="method-result">integer</span>
 524          <span class="method-name">
 525              getCacheExpire
 526          </span>
 527                  ()
 528              </div>
 529      
 530          
 531          
 532      </div>
 533  <a name="methodgetCharset" id="getCharset"><!-- --></a>
 534  <div class="oddrow">
 535      
 536      <div class="method-header">
 537          <span class="method-title">getCharset</span> (line <span class="line-number">152</span>)
 538      </div> 
 539      
 540      <!-- ========== Info from phpDoc block ========= -->
 541      <ul class="tags">
 542                  <li><span class="field">return:</span> output charset.</li>
 543                  <li><span class="field">access:</span> public</li>
 544              </ul>
 545      
 546      <div class="method-signature">
 547          <span class="method-result">string</span>
 548          <span class="method-name">
 549              getCharset
 550          </span>
 551                  ()
 552              </div>
 553      
 554          
 555          
 556      </div>
 557  <a name="methodgetContents" id="getContents"><!-- --></a>
 558  <div class="evenrow">
 559      
 560      <div class="method-header">
 561          <span class="method-title">getContents</span> (line <span class="line-number">336</span>)
 562      </div> 
 563      
 564      <!-- ========== Info from phpDoc block ========= -->
 565  <p class="short-description">Returns the content in the output buffer.</p>
 566  <p class="description"><p>The buffer will NOT be cleared after calling this method.  Use <a href="../System.Web/THttpResponse.html#methodclear">clear()</a> is you want to clear the buffer.</p></p>
 567      <ul class="tags">
 568                  <li><span class="field">return:</span> output that is in the buffer.</li>
 569                  <li><span class="field">access:</span> public</li>
 570              </ul>
 571      
 572      <div class="method-signature">
 573          <span class="method-result">string</span>
 574          <span class="method-name">
 575              getContents
 576          </span>
 577                  ()
 578              </div>
 579      
 580          
 581          
 582      </div>
 583  <a name="methodgetContentType" id="getContentType"><!-- --></a>
 584  <div class="oddrow">
 585      
 586      <div class="method-header">
 587          <span class="method-title">getContentType</span> (line <span class="line-number">144</span>)
 588      </div> 
 589      
 590      <!-- ========== Info from phpDoc block ========= -->
 591      <ul class="tags">
 592                  <li><span class="field">return:</span> current content type</li>
 593                  <li><span class="field">access:</span> public</li>
 594              </ul>
 595      
 596      <div class="method-signature">
 597          <span class="method-result">string</span>
 598          <span class="method-name">
 599              getContentType
 600          </span>
 601                  ()
 602              </div>
 603      
 604          
 605          
 606      </div>
 607  <a name="methodgetCookies" id="getCookies"><!-- --></a>
 608  <div class="evenrow">
 609      
 610      <div class="method-header">
 611          <span class="method-title">getCookies</span> (line <span class="line-number">204</span>)
 612      </div> 
 613      
 614      <!-- ========== Info from phpDoc block ========= -->
 615      <ul class="tags">
 616                  <li><span class="field">return:</span> list of output cookies</li>
 617                  <li><span class="field">access:</span> public</li>
 618              </ul>
 619      
 620      <div class="method-signature">
 621          <span class="method-result"><a href="../System.Web/THttpCookieCollection.html">THttpCookieCollection</a></span>
 622          <span class="method-name">
 623              getCookies
 624          </span>
 625                  ()
 626              </div>
 627      
 628          
 629          
 630      </div>
 631  <a name="methodgetHtmlWriterType" id="getHtmlWriterType"><!-- --></a>
 632  <div class="oddrow">
 633      
 634      <div class="method-header">
 635          <span class="method-title">getHtmlWriterType</span> (line <span class="line-number">406</span>)
 636      </div> 
 637      
 638      <!-- ========== Info from phpDoc block ========= -->
 639      <ul class="tags">
 640                  <li><span class="field">return:</span> the type of HTML writer to be used, defaults to THtmlWriter</li>
 641                  <li><span class="field">access:</span> public</li>
 642              </ul>
 643      
 644      <div class="method-signature">
 645          <span class="method-result">string</span>
 646          <span class="method-name">
 647              getHtmlWriterType
 648          </span>
 649                  ()
 650              </div>
 651      
 652          
 653          
 654      </div>
 655  <a name="methodgetStatusCode" id="getStatusCode"><!-- --></a>
 656  <div class="evenrow">
 657      
 658      <div class="method-header">
 659          <span class="method-title">getStatusCode</span> (line <span class="line-number">188</span>)
 660      </div> 
 661      
 662      <!-- ========== Info from phpDoc block ========= -->
 663      <ul class="tags">
 664                  <li><span class="field">return:</span> HTTP status code, defaults to 200</li>
 665                  <li><span class="field">access:</span> public</li>
 666              </ul>
 667      
 668      <div class="method-signature">
 669          <span class="method-result">integer</span>
 670          <span class="method-name">
 671              getStatusCode
 672          </span>
 673                  ()
 674              </div>
 675      
 676          
 677          
 678      </div>
 679  <a name="methodinit" id="init"><!-- --></a>
 680  <div class="oddrow">
 681      
 682      <div class="method-header">
 683          <span class="method-title">init</span> (line <span class="line-number">92</span>)
 684      </div> 
 685      
 686      <!-- ========== Info from phpDoc block ========= -->
 687  <p class="short-description">Initializes the module.</p>
 688  <p class="description"><p>This method is required by IModule and is invoked by application.  It starts output buffer if it is enabled.</p></p>
 689      <ul class="tags">
 690                  <li><span class="field">access:</span> public</li>
 691              </ul>
 692      
 693      <div class="method-signature">
 694          <span class="method-result">void</span>
 695          <span class="method-name">
 696              init
 697          </span>
 698                      (<span class="var-type"><a href="../System.Xml/TXmlElement.html">TXmlElement</a></span>&nbsp;<span class="var-name">$config</span>)
 699              </div>
 700      
 701              <ul class="parameters">
 702                      <li>
 703                  <span class="var-type"><a href="../System.Xml/TXmlElement.html">TXmlElement</a></span>
 704                  <span class="var-name">$config</span><span class="var-description">: module configuration</span>            </li>
 705                  </ul>
 706          
 707              <hr class="separator" />
 708          <div class="notes">Redefinition of:</div>
 709          <dl>
 710              <dt><a href="../System/TModule.html#methodinit">TModule::init()</a></dt>
 711                          <dd>Initializes the module.</dd>
 712                      </dl>
 713          
 714      </div>
 715  <a name="methodredirect" id="redirect"><!-- --></a>
 716  <div class="evenrow">
 717      
 718      <div class="method-header">
 719          <span class="method-title">redirect</span> (line <span class="line-number">282</span>)
 720      </div> 
 721      
 722      <!-- ========== Info from phpDoc block ========= -->
 723  <p class="short-description">Redirects the browser to the specified URL.</p>
 724  <p class="description"><p>The current application will be terminated after this method is invoked.</p></p>
 725      <ul class="tags">
 726                  <li><span class="field">access:</span> public</li>
 727              </ul>
 728      
 729      <div class="method-signature">
 730          <span class="method-result">void</span>
 731          <span class="method-name">
 732              redirect
 733          </span>
 734                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
 735              </div>
 736      
 737              <ul class="parameters">
 738                      <li>
 739                  <span class="var-type">string</span>
 740                  <span class="var-name">$url</span><span class="var-description">: URL to be redirected to. If the URL is a relative one, the base URL of  the current request will be inserted at the beginning.</span>            </li>
 741                  </ul>
 742          
 743          
 744      </div>
 745  <a name="methodreload" id="reload"><!-- --></a>
 746  <div class="oddrow">
 747      
 748      <div class="method-header">
 749          <span class="method-title">reload</span> (line <span class="line-number">297</span>)
 750      </div> 
 751      
 752      <!-- ========== Info from phpDoc block ========= -->
 753  <p class="short-description">Reloads the current page.</p>
 754  <p class="description"><p>The effect of this method call is the same as user pressing the  refresh button on his browser (without post data).</p></p>
 755      <ul class="tags">
 756                  <li><span class="field">access:</span> public</li>
 757              </ul>
 758      
 759      <div class="method-signature">
 760          <span class="method-result">void</span>
 761          <span class="method-name">
 762              reload
 763          </span>
 764                  ()
 765              </div>
 766      
 767          
 768          
 769      </div>
 770  <a name="methodremoveCookie" id="removeCookie"><!-- --></a>
 771  <div class="evenrow">
 772      
 773      <div class="method-header">
 774          <span class="method-title">removeCookie</span> (line <span class="line-number">398</span>)
 775      </div> 
 776      
 777      <!-- ========== Info from phpDoc block ========= -->
 778  <p class="short-description">Deletes a cookie.</p>
 779  <p class="description"><p>Do not call this method directly. Operate with the result of <a href="../System.Web/THttpResponse.html#methodgetCookies">getCookies</a> instead.</p></p>
 780      <ul class="tags">
 781                  <li><span class="field">access:</span> public</li>
 782              </ul>
 783      
 784      <div class="method-signature">
 785          <span class="method-result">void</span>
 786          <span class="method-name">
 787              removeCookie
 788          </span>
 789                      (<span class="var-type"><a href="../System.Web/THttpCookie.html">THttpCookie</a></span>&nbsp;<span class="var-name">$cookie</span>)
 790              </div>
 791      
 792              <ul class="parameters">
 793                      <li>
 794                  <span class="var-type"><a href="../System.Web/THttpCookie.html">THttpCookie</a></span>
 795                  <span class="var-name">$cookie</span><span class="var-description">: cook to be deleted</span>            </li>
 796                  </ul>
 797          
 798          
 799      </div>
 800  <a name="methodsendContentTypeHeader" id="sendContentTypeHeader"><!-- --></a>
 801  <div class="oddrow">
 802      
 803      <div class="method-header">
 804          <span class="method-title">sendContentTypeHeader</span> (line <span class="line-number">316</span>)
 805      </div> 
 806      
 807      <!-- ========== Info from phpDoc block ========= -->
 808  <p class="short-description">Sends content type header if charset is not empty.</p>
 809      <ul class="tags">
 810                  <li><span class="field">access:</span> protected</li>
 811              </ul>
 812      
 813      <div class="method-signature">
 814          <span class="method-result">void</span>
 815          <span class="method-name">
 816              sendContentTypeHeader
 817          </span>
 818                  ()
 819              </div>
 820      
 821          
 822          
 823      </div>
 824  <a name="methodsetBufferOutput" id="setBufferOutput"><!-- --></a>
 825  <div class="evenrow">
 826      
 827      <div class="method-header">
 828          <span class="method-title">setBufferOutput</span> (line <span class="line-number">177</span>)
 829      </div> 
 830      
 831      <!-- ========== Info from phpDoc block ========= -->
 832      <ul class="tags">
 833                  <li><span class="field">access:</span> public</li>
 834                  <li><span class="field">throws:</span> TInvalidOperationException if session is started already</li>
 835              </ul>
 836      
 837      <div class="method-signature">
 838          <span class="method-result">void</span>
 839          <span class="method-name">
 840              setBufferOutput
 841          </span>
 842                      (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$value</span>)
 843              </div>
 844      
 845              <ul class="parameters">
 846                      <li>
 847                  <span class="var-type">boolean</span>
 848                  <span class="var-name">$value</span><span class="var-description">: whether to enable output buffer</span>            </li>
 849                  </ul>
 850          
 851          
 852      </div>
 853  <a name="methodsetCacheControl" id="setCacheControl"><!-- --></a>
 854  <div class="oddrow">
 855      
 856      <div class="method-header">
 857          <span class="method-title">setCacheControl</span> (line <span class="line-number">128</span>)
 858      </div> 
 859      
 860      <!-- ========== Info from phpDoc block ========= -->
 861      <ul class="tags">
 862                  <li><span class="field">access:</span> public</li>
 863              </ul>
 864      
 865      <div class="method-signature">
 866          <span class="method-result">void</span>
 867          <span class="method-name">
 868              setCacheControl
 869          </span>
 870                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 871              </div>
 872      
 873              <ul class="parameters">
 874                      <li>
 875                  <span class="var-type">string</span>
 876                  <span class="var-name">$value</span><span class="var-description">: cache control method to use for session pages. Valid values                include none/nocache/private/private_no_expire/public</span>            </li>
 877                  </ul>
 878          
 879          
 880      </div>
 881  <a name="methodsetCacheExpire" id="setCacheExpire"><!-- --></a>
 882  <div class="evenrow">
 883      
 884      <div class="method-header">
 885          <span class="method-title">setCacheExpire</span> (line <span class="line-number">111</span>)
 886      </div> 
 887      
 888      <!-- ========== Info from phpDoc block ========= -->
 889      <ul class="tags">
 890                  <li><span class="field">access:</span> public</li>
 891              </ul>
 892      
 893      <div class="method-signature">
 894          <span class="method-result">void</span>
 895          <span class="method-name">
 896              setCacheExpire
 897          </span>
 898                      (<span class="var-type">integer</span>&nbsp;<span class="var-name">$value</span>)
 899              </div>
 900      
 901              <ul class="parameters">
 902                      <li>
 903                  <span class="var-type">integer</span>
 904                  <span class="var-name">$value</span><span class="var-description">: time-to-live for cached session pages in minutes, this has no effect for nocache limiter.</span>            </li>
 905                  </ul>
 906          
 907          
 908      </div>
 909  <a name="methodsetCharset" id="setCharset"><!-- --></a>
 910  <div class="oddrow">
 911      
 912      <div class="method-header">
 913          <span class="method-title">setCharset</span> (line <span class="line-number">160</span>)
 914      </div> 
 915      
 916      <!-- ========== Info from phpDoc block ========= -->
 917      <ul class="tags">
 918                  <li><span class="field">access:</span> public</li>
 919              </ul>
 920      
 921      <div class="method-signature">
 922          <span class="method-result">void</span>
 923          <span class="method-name">
 924              setCharset
 925          </span>
 926                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$charset</span>)
 927              </div>
 928      
 929              <ul class="parameters">
 930                      <li>
 931                  <span class="var-type">string</span>
 932                  <span class="var-name">$charset</span><span class="var-description">: output charset.</span>            </li>
 933                  </ul>
 934          
 935          
 936      </div>
 937  <a name="methodsetContentType" id="setContentType"><!-- --></a>
 938  <div class="evenrow">
 939      
 940      <div class="method-header">
 941          <span class="method-title">setContentType</span> (line <span class="line-number">136</span>)
 942      </div> 
 943      
 944      <!-- ========== Info from phpDoc block ========= -->
 945      <ul class="tags">
 946                  <li><span class="field">return:</span> content type, default is text/html</li>
 947                  <li><span class="field">access:</span> public</li>
 948              </ul>
 949      
 950      <div class="method-signature">
 951          <span class="method-result">string</span>
 952          <span class="method-name">
 953              setContentType
 954          </span>
 955                      (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$type</span>)
 956              </div>
 957      
 958          
 959          
 960      </div>
 961  <a name="methodsetHtmlWriterType" id="setHtmlWriterType"><!-- --></a>
 962  <div class="oddrow">
 963      
 964      <div class="method-header">
 965          <span class="method-title">setHtmlWriterType</span> (line <span class="line-number">414</span>)
 966      </div> 
 967      
 968      <!-- ========== Info from phpDoc block ========= -->
 969      <ul class="tags">
 970                  <li><span class="field">access:</span> public</li>
 971              </ul>
 972      
 973      <div class="method-signature">
 974          <span class="method-result">void</span>
 975          <span class="method-name">
 976              setHtmlWriterType
 977          </span>
 978                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 979              </div>
 980      
 981              <ul class="parameters">
 982                      <li>
 983                  <span class="var-type">string</span>
 984                  <span class="var-name">$value</span><span class="var-description">: the type of HTML writer to be used, may be the class name or the namespace</span>            </li>
 985                  </ul>
 986          
 987          
 988      </div>
 989  <a name="methodsetStatusCode" id="setStatusCode"><!-- --></a>
 990  <div class="evenrow">
 991      
 992      <div class="method-header">
 993          <span class="method-title">setStatusCode</span> (line <span class="line-number">196</span>)
 994      </div> 
 995      
 996      <!-- ========== Info from phpDoc block ========= -->
 997      <ul class="tags">
 998                  <li><span class="field">access:</span> public</li>
 999              </ul>
1000      
1001      <div class="method-signature">
1002          <span class="method-result">void</span>
1003          <span class="method-name">
1004              setStatusCode
1005          </span>
1006                      (<span class="var-type">integer</span>&nbsp;<span class="var-name">$status</span>)
1007              </div>
1008      
1009              <ul class="parameters">
1010                      <li>
1011                  <span class="var-type">integer</span>
1012                  <span class="var-name">$status</span><span class="var-description">: HTTP status code</span>            </li>
1013                  </ul>
1014          
1015          
1016      </div>
1017  <a name="methodwrite" id="write"><!-- --></a>
1018  <div class="oddrow">
1019      
1020      <div class="method-header">
1021          <span class="method-title">write</span> (line <span class="line-number">216</span>)
1022      </div> 
1023      
1024      <!-- ========== Info from phpDoc block ========= -->
1025  <p class="short-description">Outputs a string.</p>
1026  <p class="description"><p>It may not be sent back to user immediately if output buffer is enabled.</p></p>
1027      <ul class="tags">
1028                  <li><span class="field">access:</span> public</li>
1029              </ul>
1030      
1031      <div class="method-signature">
1032          <span class="method-result">void</span>
1033          <span class="method-name">
1034              write
1035          </span>
1036                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$str</span>)
1037              </div>
1038      
1039              <ul class="parameters">
1040                      <li>
1041                  <span class="var-type">string</span>
1042                  <span class="var-name">$str</span><span class="var-description">: string to be output</span>            </li>
1043                  </ul>
1044          
1045          
1046      </div>
1047  <a name="methodwriteFile" id="writeFile"><!-- --></a>
1048  <div class="evenrow">
1049      
1050      <div class="method-header">
1051          <span class="method-title">writeFile</span> (line <span class="line-number">230</span>)
1052      </div> 
1053      
1054      <!-- ========== Info from phpDoc block ========= -->
1055  <p class="short-description">Sends a file back to user.</p>
1056  <p class="description"><p>Make sure not to output anything else after calling this method.</p></p>
1057      <ul class="tags">
1058                  <li><span class="field">access:</span> public</li>
1059                  <li><span class="field">throws:</span> TInvalidDataValueException if the file cannot be found</li>
1060              </ul>
1061      
1062      <div class="method-signature">
1063          <span class="method-result">void</span>
1064          <span class="method-name">
1065              writeFile
1066          </span>
1067                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$fileName</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$content</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$mimeType</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$headers</span> = <span class="var-default">null</span>])
1068              </div>
1069      
1070              <ul class="parameters">
1071                      <li>
1072                  <span class="var-type">string</span>
1073                  <span class="var-name">$fileName</span><span class="var-description">: file name</span>            </li>
1074                      <li>
1075                  <span class="var-type">string</span>
1076                  <span class="var-name">$content</span><span class="var-description">: content to be set. If null, the content will be read from the server file pointed to by $fileName.</span>            </li>
1077                      <li>
1078                  <span class="var-type">string</span>
1079                  <span class="var-name">$mimeType</span><span class="var-description">: mime type of the content.</span>            </li>
1080                      <li>
1081                  <span class="var-type">array</span>
1082                  <span class="var-name">$headers</span><span class="var-description">: list of headers to be sent</span>            </li>
1083                  </ul>
1084          
1085          
1086      </div>
1087                              <h4>Inherited Methods</h4>
1088                  <a name='inherited_methods'><!-- --></a>    
1089                                      <!-- =========== Summary =========== -->
1090                      <p>Inherited From <span class="classname"><a href="../System/TModule.html">TModule</a></span></p>
1091                      <blockquote>
1092                                                      <span class="method-name"><a href="../System/TModule.html#methodgetID">TModule::getID()</a></span><br>
1093                                                      <span class="method-name"><a href="../System/TModule.html#methodinit">TModule::init()</a></span><br>
1094                                                      <span class="method-name"><a href="../System/TModule.html#methodsetID">TModule::setID()</a></span><br>
1095                                              </blockquote>
1096                                      <!-- =========== Summary =========== -->
1097                      <p>Inherited From <span class="classname"><a href="../System/TApplicationComponent.html">TApplicationComponent</a></span></p>
1098                      <blockquote>
1099                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetApplication">TApplicationComponent::getApplication()</a></span><br>
1100                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetRequest">TApplicationComponent::getRequest()</a></span><br>
1101                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetResponse">TApplicationComponent::getResponse()</a></span><br>
1102                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetService">TApplicationComponent::getService()</a></span><br>
1103                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetSession">TApplicationComponent::getSession()</a></span><br>
1104                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetUser">TApplicationComponent::getUser()</a></span><br>
1105                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodpublishAsset">TApplicationComponent::publishAsset()</a></span><br>
1106                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodpublishFilePath">TApplicationComponent::publishFilePath()</a></span><br>
1107                                              </blockquote>
1108                                      <!-- =========== Summary =========== -->
1109                      <p>Inherited From <span class="classname"><a href="../System/TComponent.html">TComponent</a></span></p>
1110                      <blockquote>
1111                                                      <span class="method-name"><a href="../System/TComponent.html#methodaddParsedObject">TComponent::addParsedObject()</a></span><br>
1112                                                      <span class="method-name"><a href="../System/TComponent.html#methodattachEventHandler">TComponent::attachEventHandler()</a></span><br>
1113                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanGetProperty">TComponent::canGetProperty()</a></span><br>
1114                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanSetProperty">TComponent::canSetProperty()</a></span><br>
1115                                                      <span class="method-name"><a href="../System/TComponent.html#methodcreatedOnTemplate">TComponent::createdOnTemplate()</a></span><br>
1116                                                      <span class="method-name"><a href="../System/TComponent.html#methoddetachEventHandler">TComponent::detachEventHandler()</a></span><br>
1117                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateExpression">TComponent::evaluateExpression()</a></span><br>
1118                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateStatements">TComponent::evaluateStatements()</a></span><br>
1119                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetEventHandlers">TComponent::getEventHandlers()</a></span><br>
1120                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetSubProperty">TComponent::getSubProperty()</a></span><br>
1121                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEvent">TComponent::hasEvent()</a></span><br>
1122                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEventHandler">TComponent::hasEventHandler()</a></span><br>
1123                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasProperty">TComponent::hasProperty()</a></span><br>
1124                                                      <span class="method-name"><a href="../System/TComponent.html#methodraiseEvent">TComponent::raiseEvent()</a></span><br>
1125                                                      <span class="method-name"><a href="../System/TComponent.html#methodsetSubProperty">TComponent::setSubProperty()</a></span><br>
1126                                                      <span class="method-name"><a href="../System/TComponent.html#method__get">TComponent::__get()</a></span><br>
1127                                                      <span class="method-name"><a href="../System/TComponent.html#method__set">TComponent::__set()</a></span><br>
1128                                              </blockquote>
1129                                          
1130          </div>
1131      </div>
1132  
1133  
1134      <p class="notes" id="credit">
1135          Documentation generated on Mon, 04 Dec 2006 11:26:47 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC4</a>
1136      </p>
1137      </div></body>
1138  </html>