[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 TException</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 TException</h2>
  13  
  14  <a name="sec-description"></a>
  15  <div class="info-box">
  16      <div class="info-box-title">Description</div>
  17      <div class="nav-bar">
  18                      <span class="disabled">Description</span> |
  19                              <a href="#sec-descendents">Descendents</a>
  20              |                                                    <a href="#sec-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">TException class</p>
  26  <p class="description"><p>TException is the base class for all PRADO exceptions.</p><p>TException provides the functionality of translating an error code  into a descriptive error message in a language that is preferred  by user browser. Additional parameters may be passed together with  the error code so that the translated message contains more detailed  information.</p><p>By default, TException looks for a message file by calling  <a href="../System.Exceptions/TException.html#methodgetErrorMessageFile">getErrorMessageFile()</a> method, which uses the &quot;message-xx.txt&quot;  file located under &quot;System.Exceptions&quot; folder, where &quot;xx&quot; is the  code of the user preferred language. If such a file is not found,  &quot;message.txt&quot; will be used instead.</p></p>
  27      <ul class="tags">
  28                  <li><span class="field">since:</span> 3.0</li>
  29                  <li><span class="field">version:</span> $Id: TException.php 1397 2006-09-07 07:55:53Z wei $</li>
  30                  <li><span class="field">author:</span> Qiang Xue &lt;<a href="mailto:qiang.xue@gmail.com">qiang.xue@gmail.com</a>&gt;</li>
  31              </ul>
  32          <p class="notes">
  33              Located in <a class="field" href="_Exceptions_TException_php.html">/Exceptions/TException.php</a> (line <span class="field">35</span>)
  34          </p>
  35          
  36                  
  37          <pre>Exception
  38     |
  39     --TException</pre>
  40      
  41              </div>
  42  </div>
  43  
  44      <a name="sec-descendents"></a>
  45      <div class="info-box">
  46          <div class="info-box-title">Direct descendents</div>
  47          <div class="nav-bar">
  48              <a href="#sec-description">Description</a> |
  49              <span class="disabled">Descendents</span>
  50              |                                                            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  51                              
  52                                  </div>
  53          <div class="info-box-body">
  54              <table cellpadding="2" cellspacing="0" class="class-table">
  55                  <tr>
  56                      <th class="class-table-header">Class</th>
  57                      <th class="class-table-header">Description</th>
  58                  </tr>
  59                                  <tr>
  60                      <td style="padding-right: 2em"><a href="../System.Exceptions/TSystemException.html">TSystemException</a></td>
  61                      <td>
  62                                              TSystemException class
  63                                          </td>
  64                  </tr>
  65                                  <tr>
  66                      <td style="padding-right: 2em"><a href="../System.Exceptions/TApplicationException.html">TApplicationException</a></td>
  67                      <td>
  68                                              TApplicationException class
  69                                          </td>
  70                  </tr>
  71                              </table>
  72          </div>
  73      </div>
  74  
  75  
  76  
  77      <a name="sec-method-summary"></a>
  78      <div class="info-box">
  79          <div class="info-box-title">Method Summary</span></div>
  80          <div class="nav-bar">
  81              <a href="#sec-description">Description</a> |
  82                              <a href="#sec-descendents">Descendents</a> |
  83                                                  <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  84          </div>
  85          <div class="info-box-body">            
  86              <div class="method-summary">
  87                                  
  88                  <div class="method-definition">
  89                                              <span class="method-result">TException</span>
  90                                          <a href="#__construct" title="details" class="method-name">__construct</a>
  91                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$errorMessage</span>)
  92                                      </div>
  93                                  
  94                  <div class="method-definition">
  95                                              <span class="method-result">string</span>
  96                                          <a href="#getErrorCode" title="details" class="method-name">getErrorCode</a>
  97                                          ()
  98                                      </div>
  99                                  
 100                  <div class="method-definition">
 101                                              <span class="method-result">string</span>
 102                                          <a href="#getErrorMessage" title="details" class="method-name">getErrorMessage</a>
 103                                          ()
 104                                      </div>
 105                                  
 106                  <div class="method-definition">
 107                                              <span class="method-result">string</span>
 108                                          <a href="#getErrorMessageFile" title="details" class="method-name">getErrorMessageFile</a>
 109                                          ()
 110                                      </div>
 111                                  
 112                  <div class="method-definition">
 113                                              <span class="method-result">void</span>
 114                                          <a href="#setErrorCode" title="details" class="method-name">setErrorCode</a>
 115                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>)
 116                                      </div>
 117                                  
 118                  <div class="method-definition">
 119                                              <span class="method-result">void</span>
 120                                          <a href="#setErrorMessage" title="details" class="method-name">setErrorMessage</a>
 121                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>)
 122                                      </div>
 123                                  
 124                  <div class="method-definition">
 125                                              <span class="method-result">string</span>
 126                                          <a href="#translateErrorMessage" title="details" class="method-name">translateErrorMessage</a>
 127                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
 128                                      </div>
 129                              </div>
 130          </div>
 131      </div>        
 132  
 133      
 134      <a name="sec-methods"></a>
 135      <div class="info-box">
 136          <div class="info-box-title">Methods</div>
 137          <div class="nav-bar">
 138              <a href="#sec-description">Description</a> |
 139                              <a href="#sec-descendents">Descendents</a> |
 140                                                                  <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 141                          
 142          </div>
 143          <div class="info-box-body">
 144              <A NAME='method_detail'></A>
 145  <a name="method__construct" id="__construct"><!-- --></a>
 146  <div class="oddrow">
 147      
 148      <div class="method-header">
 149          <span class="method-title">Constructor __construct</span> (line <span class="line-number">46</span>)
 150      </div> 
 151      
 152      <!-- ========== Info from phpDoc block ========= -->
 153  <p class="short-description">Constructor.</p>
 154      <ul class="tags">
 155                  <li><span class="field">access:</span> public</li>
 156              </ul>
 157      
 158      <div class="method-signature">
 159          <span class="method-result">TException</span>
 160          <span class="method-name">
 161              __construct
 162          </span>
 163                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$errorMessage</span>)
 164              </div>
 165      
 166              <ul class="parameters">
 167                      <li>
 168                  <span class="var-type">string</span>
 169                  <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>
 170                  </ul>
 171          
 172          
 173              <hr class="separator" />
 174          <div class="notes">Redefined in descendants as:</div>
 175          <ul class="redefinitions">
 176                      <li>
 177                  <a href="../System.Exceptions/TPhpErrorException.html#method__construct">TPhpErrorException::__construct()</a>
 178                                  : Constructor.
 179                              </li>
 180                      <li>
 181                  <a href="../System.Exceptions/THttpException.html#method__construct">THttpException::__construct()</a>
 182                                  : Constructor.
 183                              </li>
 184                  </ul>
 185      </div>
 186  <a name="methodgetErrorCode" id="getErrorCode"><!-- --></a>
 187  <div class="evenrow">
 188      
 189      <div class="method-header">
 190          <span class="method-title">getErrorCode</span> (line <span class="line-number">96</span>)
 191      </div> 
 192      
 193      <!-- ========== Info from phpDoc block ========= -->
 194      <ul class="tags">
 195                  <li><span class="field">return:</span> error code</li>
 196                  <li><span class="field">access:</span> public</li>
 197              </ul>
 198      
 199      <div class="method-signature">
 200          <span class="method-result">string</span>
 201          <span class="method-name">
 202              getErrorCode
 203          </span>
 204                  ()
 205              </div>
 206      
 207          
 208          
 209      </div>
 210  <a name="methodgetErrorMessage" id="getErrorMessage"><!-- --></a>
 211  <div class="oddrow">
 212      
 213      <div class="method-header">
 214          <span class="method-title">getErrorMessage</span> (line <span class="line-number">112</span>)
 215      </div> 
 216      
 217      <!-- ========== Info from phpDoc block ========= -->
 218      <ul class="tags">
 219                  <li><span class="field">return:</span> error message</li>
 220                  <li><span class="field">access:</span> public</li>
 221              </ul>
 222      
 223      <div class="method-signature">
 224          <span class="method-result">string</span>
 225          <span class="method-name">
 226              getErrorMessage
 227          </span>
 228                  ()
 229              </div>
 230      
 231          
 232          
 233      </div>
 234  <a name="methodgetErrorMessageFile" id="getErrorMessageFile"><!-- --></a>
 235  <div class="evenrow">
 236      
 237      <div class="method-header">
 238          <span class="method-title">getErrorMessageFile</span> (line <span class="line-number">84</span>)
 239      </div> 
 240      
 241      <!-- ========== Info from phpDoc block ========= -->
 242      <ul class="tags">
 243                  <li><span class="field">return:</span> path to the error message file</li>
 244                  <li><span class="field">access:</span> protected</li>
 245              </ul>
 246      
 247      <div class="method-signature">
 248          <span class="method-result">string</span>
 249          <span class="method-name">
 250              getErrorMessageFile
 251          </span>
 252                  ()
 253              </div>
 254      
 255          
 256          
 257      </div>
 258  <a name="methodsetErrorCode" id="setErrorCode"><!-- --></a>
 259  <div class="oddrow">
 260      
 261      <div class="method-header">
 262          <span class="method-title">setErrorCode</span> (line <span class="line-number">104</span>)
 263      </div> 
 264      
 265      <!-- ========== Info from phpDoc block ========= -->
 266      <ul class="tags">
 267                  <li><span class="field">access:</span> public</li>
 268              </ul>
 269      
 270      <div class="method-signature">
 271          <span class="method-result">void</span>
 272          <span class="method-name">
 273              setErrorCode
 274          </span>
 275                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>)
 276              </div>
 277      
 278              <ul class="parameters">
 279                      <li>
 280                  <span class="var-type">string</span>
 281                  <span class="var-name">$code</span><span class="var-description">: error code</span>            </li>
 282                  </ul>
 283          
 284          
 285      </div>
 286  <a name="methodsetErrorMessage" id="setErrorMessage"><!-- --></a>
 287  <div class="evenrow">
 288      
 289      <div class="method-header">
 290          <span class="method-title">setErrorMessage</span> (line <span class="line-number">120</span>)
 291      </div> 
 292      
 293      <!-- ========== Info from phpDoc block ========= -->
 294      <ul class="tags">
 295                  <li><span class="field">access:</span> protected</li>
 296              </ul>
 297      
 298      <div class="method-signature">
 299          <span class="method-result">void</span>
 300          <span class="method-name">
 301              setErrorMessage
 302          </span>
 303                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>)
 304              </div>
 305      
 306              <ul class="parameters">
 307                      <li>
 308                  <span class="var-type">string</span>
 309                  <span class="var-name">$message</span><span class="var-description">: error message</span>            </li>
 310                  </ul>
 311          
 312          
 313      </div>
 314  <a name="methodtranslateErrorMessage" id="translateErrorMessage"><!-- --></a>
 315  <div class="oddrow">
 316      
 317      <div class="method-header">
 318          <span class="method-title">translateErrorMessage</span> (line <span class="line-number">64</span>)
 319      </div> 
 320      
 321      <!-- ========== Info from phpDoc block ========= -->
 322  <p class="short-description">Translates an error code into an error message.</p>
 323      <ul class="tags">
 324                  <li><span class="field">return:</span> the translated error message</li>
 325                  <li><span class="field">access:</span> protected</li>
 326              </ul>
 327      
 328      <div class="method-signature">
 329          <span class="method-result">string</span>
 330          <span class="method-name">
 331              translateErrorMessage
 332          </span>
 333                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
 334              </div>
 335      
 336              <ul class="parameters">
 337                      <li>
 338                  <span class="var-type">string</span>
 339                  <span class="var-name">$key</span><span class="var-description">: error code that is passed in the exception constructor.</span>            </li>
 340                  </ul>
 341          
 342          
 343      </div>
 344                          
 345          </div>
 346      </div>
 347  
 348  
 349      <p class="notes" id="credit">
 350          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>
 351      </p>
 352      </div></body>
 353  </html>