[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 THttpException</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 THttpException</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                  <!-- ========== Info from phpDoc block ========= -->
  24  <p class="short-description">THttpException class</p>
  25  <p class="description"><p>THttpException represents an exception that is caused by invalid operations  of end-users. The <a href="../System.Exceptions/THttpException.html#methodgetStatusCode">StatusCode</a> gives the type of HTTP error.  It is used by <a href="../System.Exceptions/TErrorHandler.html">TErrorHandler</a> to provide different error output to users.</p></p>
  26      <ul class="tags">
  27                  <li><span class="field">since:</span> 3.0</li>
  28                  <li><span class="field">version:</span> $Id: TException.php 1397 2006-09-07 07:55:53Z wei $</li>
  29                  <li><span class="field">author:</span> Qiang Xue &lt;<a href="mailto:qiang.xue@gmail.com">qiang.xue@gmail.com</a>&gt;</li>
  30              </ul>
  31          <p class="notes">
  32              Located in <a class="field" href="_Exceptions_TException_php.html">/Exceptions/TException.php</a> (line <span class="field">321</span>)
  33          </p>
  34          
  35                  
  36          <pre>Exception
  37     |
  38     --<a href="../System.Exceptions/TException.html">TException</a>
  39        |
  40        --<a href="../System.Exceptions/TSystemException.html">TSystemException</a>
  41           |
  42           --THttpException</pre>
  43      
  44              </div>
  45  </div>
  46  
  47  
  48  
  49  
  50      <a name="sec-method-summary"></a>
  51      <div class="info-box">
  52          <div class="info-box-title">Method Summary</span></div>
  53          <div class="nav-bar">
  54              <a href="#sec-description">Description</a> |
  55                                                  <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  56          </div>
  57          <div class="info-box-body">            
  58              <div class="method-summary">
  59                                  
  60                  <div class="method-definition">
  61                                              <span class="method-result">THttpException</span>
  62                                          <a href="#__construct" title="details" class="method-name">__construct</a>
  63                                              (<span class="var-type">integer</span>&nbsp;<span class="var-name">$statusCode</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$errorMessage</span>)
  64                                      </div>
  65                                  
  66                  <div class="method-definition">
  67                                              <span class="method-result">integer</span>
  68                                          <a href="#getStatusCode" title="details" class="method-name">getStatusCode</a>
  69                                          ()
  70                                      </div>
  71                              </div>
  72          </div>
  73      </div>        
  74  
  75      
  76      <a name="sec-methods"></a>
  77      <div class="info-box">
  78          <div class="info-box-title">Methods</div>
  79          <div class="nav-bar">
  80              <a href="#sec-description">Description</a> |
  81                                                                  <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  82                          
  83          </div>
  84          <div class="info-box-body">
  85              <A NAME='method_detail'></A>
  86  <a name="method__construct" id="__construct"><!-- --></a>
  87  <div class="evenrow">
  88      
  89      <div class="method-header">
  90          <span class="method-title">Constructor __construct</span> (line <span class="line-number">333</span>)
  91      </div> 
  92      
  93      <!-- ========== Info from phpDoc block ========= -->
  94  <p class="short-description">Constructor.</p>
  95      <ul class="tags">
  96                  <li><span class="field">access:</span> public</li>
  97              </ul>
  98      
  99      <div class="method-signature">
 100          <span class="method-result">THttpException</span>
 101          <span class="method-name">
 102              __construct
 103          </span>
 104                      (<span class="var-type">integer</span>&nbsp;<span class="var-name">$statusCode</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$errorMessage</span>)
 105              </div>
 106      
 107              <ul class="parameters">
 108                      <li>
 109                  <span class="var-type">integer</span>
 110                  <span class="var-name">$statusCode</span><span class="var-description">: HTTP status code, such as 404, 500, etc.</span>            </li>
 111                      <li>
 112                  <span class="var-type">string</span>
 113                  <span class="var-name">$errorMessage</span><span class="var-description">: error message. This can be a string that is listed  in the message file. If so, the message in the preferred language  will be used as the error message. Any rest parameters will be used  to replace placeholders ({0}, {1}, {2}, etc.) in the message.</span>            </li>
 114                  </ul>
 115          
 116              <hr class="separator" />
 117          <div class="notes">Redefinition of:</div>
 118          <dl>
 119              <dt><a href="../System.Exceptions/TException.html#method__construct">TException::__construct()</a></dt>
 120                          <dd>Constructor.</dd>
 121                      </dl>
 122          
 123      </div>
 124  <a name="methodgetStatusCode" id="getStatusCode"><!-- --></a>
 125  <div class="oddrow">
 126      
 127      <div class="method-header">
 128          <span class="method-title">getStatusCode</span> (line <span class="line-number">351</span>)
 129      </div> 
 130      
 131      <!-- ========== Info from phpDoc block ========= -->
 132      <ul class="tags">
 133                  <li><span class="field">return:</span> HTTP status code, such as 404, 500, etc.</li>
 134                  <li><span class="field">access:</span> public</li>
 135              </ul>
 136      
 137      <div class="method-signature">
 138          <span class="method-result">integer</span>
 139          <span class="method-name">
 140              getStatusCode
 141          </span>
 142                  ()
 143              </div>
 144      
 145          
 146          
 147      </div>
 148                              <h4>Inherited Methods</h4>
 149                  <a name='inherited_methods'><!-- --></a>    
 150                                      <!-- =========== Summary =========== -->
 151                      <p>Inherited From <span class="classname"><a href="../System.Exceptions/TException.html">TException</a></span></p>
 152                      <blockquote>
 153                                                      <span class="method-name"><a href="../System.Exceptions/TException.html#method__construct">TException::__construct()</a></span><br>
 154                                                      <span class="method-name"><a href="../System.Exceptions/TException.html#methodgetErrorCode">TException::getErrorCode()</a></span><br>
 155                                                      <span class="method-name"><a href="../System.Exceptions/TException.html#methodgetErrorMessage">TException::getErrorMessage()</a></span><br>
 156                                                      <span class="method-name"><a href="../System.Exceptions/TException.html#methodgetErrorMessageFile">TException::getErrorMessageFile()</a></span><br>
 157                                                      <span class="method-name"><a href="../System.Exceptions/TException.html#methodsetErrorCode">TException::setErrorCode()</a></span><br>
 158                                                      <span class="method-name"><a href="../System.Exceptions/TException.html#methodsetErrorMessage">TException::setErrorMessage()</a></span><br>
 159                                                      <span class="method-name"><a href="../System.Exceptions/TException.html#methodtranslateErrorMessage">TException::translateErrorMessage()</a></span><br>
 160                                              </blockquote>
 161                                          
 162          </div>
 163      </div>
 164  
 165  
 166      <p class="notes" id="credit">
 167          Documentation generated on Mon, 04 Dec 2006 11:26:37 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC4</a>
 168      </p>
 169      </div></body>
 170  </html>