[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 TFileLogRoute</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 TFileLogRoute</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-vars">Vars</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">TFileLogRoute class.</p>
  26  <p class="description"><p>TFileLogRoute records log messages in files.  The log files are stored under <a href="../System.Util/TFileLogRoute.html#methodsetLogPath">LogPath</a> and the file name  is specified by <a href="../System.Util/TFileLogRoute.html#methodsetLogFile">LogFile</a>. If the size of the log file is  greater than <a href="../System.Util/TFileLogRoute.html#methodsetMaxFileSize">MaxFileSize</a> (in kilo-bytes), a rotation  is performed, which renames the current log file by suffixing the file name  with '.1'. All existing log files are moved backwards one place, i.e., '.2'  to '.3', '.1' to '.2'. The property <a href="../System.Util/TFileLogRoute.html#methodsetMaxLogFiles">MaxLogFiles</a>  specifies how many files to be kept.</p></p>
  27      <ul class="tags">
  28                  <li><span class="field">since:</span> 3.0</li>
  29                  <li><span class="field">version:</span> $Id: TLogRouter.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="_Util_TLogRouter_php.html">/Util/TLogRouter.php</a> (line <span class="field">323</span>)
  34          </p>
  35          
  36                  
  37          <pre><a href="../System/TComponent.html">TComponent</a>
  38     |
  39     --<a href="../System/TApplicationComponent.html">TApplicationComponent</a>
  40        |
  41        --<a href="../System.Util/TLogRoute.html">TLogRoute</a>
  42           |
  43           --TFileLogRoute</pre>
  44      
  45              </div>
  46  </div>
  47  
  48  
  49  
  50  
  51      <a name="sec-method-summary"></a>
  52      <div class="info-box">
  53          <div class="info-box-title">Method Summary</span></div>
  54          <div class="nav-bar">
  55              <a href="#sec-description">Description</a> |
  56                                                                          <a href="#sec-vars">Vars</a>
  57                   
  58                  |
  59                          <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  60          </div>
  61          <div class="info-box-body">            
  62              <div class="method-summary">
  63                                  
  64                  <div class="method-definition">
  65                                              <span class="method-result">string</span>
  66                                          <a href="#getLogFile" title="details" class="method-name">getLogFile</a>
  67                                          ()
  68                                      </div>
  69                                  
  70                  <div class="method-definition">
  71                                              <span class="method-result">string</span>
  72                                          <a href="#getLogPath" title="details" class="method-name">getLogPath</a>
  73                                          ()
  74                                      </div>
  75                                  
  76                  <div class="method-definition">
  77                                              <span class="method-result">integer</span>
  78                                          <a href="#getMaxFileSize" title="details" class="method-name">getMaxFileSize</a>
  79                                          ()
  80                                      </div>
  81                                  
  82                  <div class="method-definition">
  83                                              <span class="method-result">integer</span>
  84                                          <a href="#getMaxLogFiles" title="details" class="method-name">getMaxLogFiles</a>
  85                                          ()
  86                                      </div>
  87                                  
  88                  <div class="method-definition">
  89                                              <span class="method-result">void</span>
  90                                          <a href="#processLogs" title="details" class="method-name">processLogs</a>
  91                                              (<span class="var-type">array</span>&nbsp;<span class="var-name">$logs</span>)
  92                                      </div>
  93                                  
  94                  <div class="method-definition">
  95                                              <span class="method-result">void</span>
  96                                          <a href="#rotateFiles" title="details" class="method-name">rotateFiles</a>
  97                                          ()
  98                                      </div>
  99                                  
 100                  <div class="method-definition">
 101                                              <span class="method-result">void</span>
 102                                          <a href="#setLogFile" title="details" class="method-name">setLogFile</a>
 103                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 104                                      </div>
 105                                  
 106                  <div class="method-definition">
 107                                              <span class="method-result">void</span>
 108                                          <a href="#setLogPath" title="details" class="method-name">setLogPath</a>
 109                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 110                                      </div>
 111                                  
 112                  <div class="method-definition">
 113                                              <span class="method-result">void</span>
 114                                          <a href="#setMaxFileSize" title="details" class="method-name">setMaxFileSize</a>
 115                                              (<span class="var-type">integer</span>&nbsp;<span class="var-name">$value</span>)
 116                                      </div>
 117                                  
 118                  <div class="method-definition">
 119                                              <span class="method-result">void</span>
 120                                          <a href="#setMaxLogFiles" title="details" class="method-name">setMaxLogFiles</a>
 121                                              (<span class="var-type">integer</span>&nbsp;<span class="var-name">$value</span>)
 122                                      </div>
 123                              </div>
 124          </div>
 125      </div>        
 126  
 127      <a name="sec-vars"></a>
 128      <div class="info-box">
 129          <div class="info-box-title">Variables</div>
 130          <div class="nav-bar">
 131              <a href="#sec-description">Description</a> |
 132                                          <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
 133                          
 134              
 135                                          | 
 136                                      <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
 137                              
 138                      </div>
 139          <div class="info-box-body">
 140              
                            <h4>Inherited Variables</h4>
 141                  <A NAME='inherited_vars'><!-- --></A>
 142                                      <p>Inherited from <span class="classname"><a href="../System.Util/TLogRoute.html">TLogRoute</a></span></p>
 143                      <blockquote>
 144                                                      <span class="var-title">
 145                                  <span class="var-name"><a href="../System.Util/TLogRoute.html#var$_levelNames">TLogRoute::$_levelNames</a></span><br>
 146                              </span>
 147                                                      <span class="var-title">
 148                                  <span class="var-name"><a href="../System.Util/TLogRoute.html#var$_levelValues">TLogRoute::$_levelValues</a></span><br>
 149                              </span>
 150                                              </blockquote> 
 151                                          
 152          </div>
 153      </div>
 154      
 155      <a name="sec-methods"></a>
 156      <div class="info-box">
 157          <div class="info-box-title">Methods</div>
 158          <div class="nav-bar">
 159              <a href="#sec-description">Description</a> |
 160                                                              <a href="#sec-vars">Vars</a>
 161                                                                      <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 162                          
 163          </div>
 164          <div class="info-box-body">
 165              <A NAME='method_detail'></A>
 166  <a name="methodgetLogFile" id="getLogFile"><!-- --></a>
 167  <div class="evenrow">
 168      
 169      <div class="method-header">
 170          <span class="method-title">getLogFile</span> (line <span class="line-number">365</span>)
 171      </div> 
 172      
 173      <!-- ========== Info from phpDoc block ========= -->
 174      <ul class="tags">
 175                  <li><span class="field">return:</span> log file name. Defaults to 'prado.log'.</li>
 176                  <li><span class="field">access:</span> public</li>
 177              </ul>
 178      
 179      <div class="method-signature">
 180          <span class="method-result">string</span>
 181          <span class="method-name">
 182              getLogFile
 183          </span>
 184                  ()
 185              </div>
 186      
 187          
 188          
 189      </div>
 190  <a name="methodgetLogPath" id="getLogPath"><!-- --></a>
 191  <div class="oddrow">
 192      
 193      <div class="method-header">
 194          <span class="method-title">getLogPath</span> (line <span class="line-number">345</span>)
 195      </div> 
 196      
 197      <!-- ========== Info from phpDoc block ========= -->
 198      <ul class="tags">
 199                  <li><span class="field">return:</span> directory storing log files. Defaults to application runtime path.</li>
 200                  <li><span class="field">access:</span> public</li>
 201              </ul>
 202      
 203      <div class="method-signature">
 204          <span class="method-result">string</span>
 205          <span class="method-name">
 206              getLogPath
 207          </span>
 208                  ()
 209              </div>
 210      
 211          
 212          
 213      </div>
 214  <a name="methodgetMaxFileSize" id="getMaxFileSize"><!-- --></a>
 215  <div class="evenrow">
 216      
 217      <div class="method-header">
 218          <span class="method-title">getMaxFileSize</span> (line <span class="line-number">381</span>)
 219      </div> 
 220      
 221      <!-- ========== Info from phpDoc block ========= -->
 222      <ul class="tags">
 223                  <li><span class="field">return:</span> maximum log file size in kilo-bytes (KB). Defaults to 1024 (1MB).</li>
 224                  <li><span class="field">access:</span> public</li>
 225              </ul>
 226      
 227      <div class="method-signature">
 228          <span class="method-result">integer</span>
 229          <span class="method-name">
 230              getMaxFileSize
 231          </span>
 232                  ()
 233              </div>
 234      
 235          
 236          
 237      </div>
 238  <a name="methodgetMaxLogFiles" id="getMaxLogFiles"><!-- --></a>
 239  <div class="oddrow">
 240      
 241      <div class="method-header">
 242          <span class="method-title">getMaxLogFiles</span> (line <span class="line-number">400</span>)
 243      </div> 
 244      
 245      <!-- ========== Info from phpDoc block ========= -->
 246      <ul class="tags">
 247                  <li><span class="field">return:</span> number of files used for rotation. Defaults to 2.</li>
 248                  <li><span class="field">access:</span> public</li>
 249              </ul>
 250      
 251      <div class="method-signature">
 252          <span class="method-result">integer</span>
 253          <span class="method-name">
 254              getMaxLogFiles
 255          </span>
 256                  ()
 257              </div>
 258      
 259          
 260          
 261      </div>
 262  <a name="methodprocessLogs" id="processLogs"><!-- --></a>
 263  <div class="evenrow">
 264      
 265      <div class="method-header">
 266          <span class="method-title">processLogs</span> (line <span class="line-number">419</span>)
 267      </div> 
 268      
 269      <!-- ========== Info from phpDoc block ========= -->
 270  <p class="short-description">Saves log messages in files.</p>
 271      <ul class="tags">
 272                  <li><span class="field">access:</span> protected</li>
 273              </ul>
 274      
 275      <div class="method-signature">
 276          <span class="method-result">void</span>
 277          <span class="method-name">
 278              processLogs
 279          </span>
 280                      (<span class="var-type">array</span>&nbsp;<span class="var-name">$logs</span>)
 281              </div>
 282      
 283              <ul class="parameters">
 284                      <li>
 285                  <span class="var-type">array</span>
 286                  <span class="var-name">$logs</span><span class="var-description">: list of log messages</span>            </li>
 287                  </ul>
 288          
 289              <hr class="separator" />
 290          <div class="notes">Redefinition of:</div>
 291          <dl>
 292              <dt><a href="../System.Util/TLogRoute.html#methodprocessLogs">TLogRoute::processLogs()</a></dt>
 293                          <dd>Processes log messages and sends them to specific destination.</dd>
 294                      </dl>
 295          
 296      </div>
 297  <a name="methodrotateFiles" id="rotateFiles"><!-- --></a>
 298  <div class="oddrow">
 299      
 300      <div class="method-header">
 301          <span class="method-title">rotateFiles</span> (line <span class="line-number">431</span>)
 302      </div> 
 303      
 304      <!-- ========== Info from phpDoc block ========= -->
 305  <p class="short-description">Rotates log files.</p>
 306      <ul class="tags">
 307                  <li><span class="field">access:</span> protected</li>
 308              </ul>
 309      
 310      <div class="method-signature">
 311          <span class="method-result">void</span>
 312          <span class="method-name">
 313              rotateFiles
 314          </span>
 315                  ()
 316              </div>
 317      
 318          
 319          
 320      </div>
 321  <a name="methodsetLogFile" id="setLogFile"><!-- --></a>
 322  <div class="evenrow">
 323      
 324      <div class="method-header">
 325          <span class="method-title">setLogFile</span> (line <span class="line-number">373</span>)
 326      </div> 
 327      
 328      <!-- ========== Info from phpDoc block ========= -->
 329      <ul class="tags">
 330                  <li><span class="field">access:</span> public</li>
 331              </ul>
 332      
 333      <div class="method-signature">
 334          <span class="method-result">void</span>
 335          <span class="method-name">
 336              setLogFile
 337          </span>
 338                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 339              </div>
 340      
 341              <ul class="parameters">
 342                      <li>
 343                  <span class="var-type">string</span>
 344                  <span class="var-name">$value</span><span class="var-description">: log file name</span>            </li>
 345                  </ul>
 346          
 347          
 348      </div>
 349  <a name="methodsetLogPath" id="setLogPath"><!-- --></a>
 350  <div class="oddrow">
 351      
 352      <div class="method-header">
 353          <span class="method-title">setLogPath</span> (line <span class="line-number">356</span>)
 354      </div> 
 355      
 356      <!-- ========== Info from phpDoc block ========= -->
 357      <ul class="tags">
 358                  <li><span class="field">access:</span> public</li>
 359                  <li><span class="field">throws:</span> TConfigurationException if log path is invalid</li>
 360              </ul>
 361      
 362      <div class="method-signature">
 363          <span class="method-result">void</span>
 364          <span class="method-name">
 365              setLogPath
 366          </span>
 367                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 368              </div>
 369      
 370              <ul class="parameters">
 371                      <li>
 372                  <span class="var-type">string</span>
 373                  <span class="var-name">$value</span><span class="var-description">: directory (in namespace format) storing log files.</span>            </li>
 374                  </ul>
 375          
 376          
 377      </div>
 378  <a name="methodsetMaxFileSize" id="setMaxFileSize"><!-- --></a>
 379  <div class="evenrow">
 380      
 381      <div class="method-header">
 382          <span class="method-title">setMaxFileSize</span> (line <span class="line-number">390</span>)
 383      </div> 
 384      
 385      <!-- ========== Info from phpDoc block ========= -->
 386      <ul class="tags">
 387                  <li><span class="field">access:</span> public</li>
 388                  <li><span class="field">throws:</span> TInvalidDataValueException if the value is smaller than 1.</li>
 389              </ul>
 390      
 391      <div class="method-signature">
 392          <span class="method-result">void</span>
 393          <span class="method-name">
 394              setMaxFileSize
 395          </span>
 396                      (<span class="var-type">integer</span>&nbsp;<span class="var-name">$value</span>)
 397              </div>
 398      
 399              <ul class="parameters">
 400                      <li>
 401                  <span class="var-type">integer</span>
 402                  <span class="var-name">$value</span><span class="var-description">: maximum log file size in kilo-bytes (KB).</span>            </li>
 403                  </ul>
 404          
 405          
 406      </div>
 407  <a name="methodsetMaxLogFiles" id="setMaxLogFiles"><!-- --></a>
 408  <div class="oddrow">
 409      
 410      <div class="method-header">
 411          <span class="method-title">setMaxLogFiles</span> (line <span class="line-number">408</span>)
 412      </div> 
 413      
 414      <!-- ========== Info from phpDoc block ========= -->
 415      <ul class="tags">
 416                  <li><span class="field">access:</span> public</li>
 417              </ul>
 418      
 419      <div class="method-signature">
 420          <span class="method-result">void</span>
 421          <span class="method-name">
 422              setMaxLogFiles
 423          </span>
 424                      (<span class="var-type">integer</span>&nbsp;<span class="var-name">$value</span>)
 425              </div>
 426      
 427              <ul class="parameters">
 428                      <li>
 429                  <span class="var-type">integer</span>
 430                  <span class="var-name">$value</span><span class="var-description">: number of files used for rotation.</span>            </li>
 431                  </ul>
 432          
 433          
 434      </div>
 435                              <h4>Inherited Methods</h4>
 436                  <a name='inherited_methods'><!-- --></a>    
 437                                      <!-- =========== Summary =========== -->
 438                      <p>Inherited From <span class="classname"><a href="../System.Util/TLogRoute.html">TLogRoute</a></span></p>
 439                      <blockquote>
 440                                                      <span class="method-name"><a href="../System.Util/TLogRoute.html#methodcollectLogs">TLogRoute::collectLogs()</a></span><br>
 441                                                      <span class="method-name"><a href="../System.Util/TLogRoute.html#methodformatLogMessage">TLogRoute::formatLogMessage()</a></span><br>
 442                                                      <span class="method-name"><a href="../System.Util/TLogRoute.html#methodgetCategories">TLogRoute::getCategories()</a></span><br>
 443                                                      <span class="method-name"><a href="../System.Util/TLogRoute.html#methodgetLevelName">TLogRoute::getLevelName()</a></span><br>
 444                                                      <span class="method-name"><a href="../System.Util/TLogRoute.html#methodgetLevels">TLogRoute::getLevels()</a></span><br>
 445                                                      <span class="method-name"><a href="../System.Util/TLogRoute.html#methodgetLevelValue">TLogRoute::getLevelValue()</a></span><br>
 446                                                      <span class="method-name"><a href="../System.Util/TLogRoute.html#methodinit">TLogRoute::init()</a></span><br>
 447                                                      <span class="method-name"><a href="../System.Util/TLogRoute.html#methodprocessLogs">TLogRoute::processLogs()</a></span><br>
 448                                                      <span class="method-name"><a href="../System.Util/TLogRoute.html#methodsetCategories">TLogRoute::setCategories()</a></span><br>
 449                                                      <span class="method-name"><a href="../System.Util/TLogRoute.html#methodsetLevels">TLogRoute::setLevels()</a></span><br>
 450                                              </blockquote>
 451                                      <!-- =========== Summary =========== -->
 452                      <p>Inherited From <span class="classname"><a href="../System/TApplicationComponent.html">TApplicationComponent</a></span></p>
 453                      <blockquote>
 454                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetApplication">TApplicationComponent::getApplication()</a></span><br>
 455                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetRequest">TApplicationComponent::getRequest()</a></span><br>
 456                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetResponse">TApplicationComponent::getResponse()</a></span><br>
 457                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetService">TApplicationComponent::getService()</a></span><br>
 458                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetSession">TApplicationComponent::getSession()</a></span><br>
 459                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetUser">TApplicationComponent::getUser()</a></span><br>
 460                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodpublishAsset">TApplicationComponent::publishAsset()</a></span><br>
 461                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodpublishFilePath">TApplicationComponent::publishFilePath()</a></span><br>
 462                                              </blockquote>
 463                                      <!-- =========== Summary =========== -->
 464                      <p>Inherited From <span class="classname"><a href="../System/TComponent.html">TComponent</a></span></p>
 465                      <blockquote>
 466                                                      <span class="method-name"><a href="../System/TComponent.html#methodaddParsedObject">TComponent::addParsedObject()</a></span><br>
 467                                                      <span class="method-name"><a href="../System/TComponent.html#methodattachEventHandler">TComponent::attachEventHandler()</a></span><br>
 468                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanGetProperty">TComponent::canGetProperty()</a></span><br>
 469                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanSetProperty">TComponent::canSetProperty()</a></span><br>
 470                                                      <span class="method-name"><a href="../System/TComponent.html#methodcreatedOnTemplate">TComponent::createdOnTemplate()</a></span><br>
 471                                                      <span class="method-name"><a href="../System/TComponent.html#methoddetachEventHandler">TComponent::detachEventHandler()</a></span><br>
 472                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateExpression">TComponent::evaluateExpression()</a></span><br>
 473                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateStatements">TComponent::evaluateStatements()</a></span><br>
 474                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetEventHandlers">TComponent::getEventHandlers()</a></span><br>
 475                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetSubProperty">TComponent::getSubProperty()</a></span><br>
 476                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEvent">TComponent::hasEvent()</a></span><br>
 477                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEventHandler">TComponent::hasEventHandler()</a></span><br>
 478                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasProperty">TComponent::hasProperty()</a></span><br>
 479                                                      <span class="method-name"><a href="../System/TComponent.html#methodraiseEvent">TComponent::raiseEvent()</a></span><br>
 480                                                      <span class="method-name"><a href="../System/TComponent.html#methodsetSubProperty">TComponent::setSubProperty()</a></span><br>
 481                                                      <span class="method-name"><a href="../System/TComponent.html#method__get">TComponent::__get()</a></span><br>
 482                                                      <span class="method-name"><a href="../System/TComponent.html#method__set">TComponent::__set()</a></span><br>
 483                                              </blockquote>
 484                                          
 485          </div>
 486      </div>
 487  
 488  
 489      <p class="notes" id="credit">
 490          Documentation generated on Mon, 04 Dec 2006 11:27:07 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC4</a>
 491      </p>
 492      </div></body>
 493  </html>