PRADO 3.0.6 : Vue détaillée de TLogRouter.php

TLogRouter, TLogRoute, TFileLogRoute, TEmailLogRoute class file

Author:	Qiang Xue <qiang.xue@gmail.com>
Copyright:	Copyright © 2005 PradoSoft
License:	http://www.pradosoft.com/license/
Version:	$Id: TLogRouter.php 1397 2006-09-07 07:55:53Z wei $
Poids:	678 lignes (19 kb)
Inclus ou requis:	0 fois
Référencé:	0 fois
Nécessite:	0 fichiers

Définit 4 classes

TLogRouter:: (14 méthodes):
  init()
  loadConfig()
  getConfigFile()
  setConfigFile()
  collectLogs()
  init()
  getLevels()
  setLevels()
  getCategories()
  setCategories()
  getLevelName()
  getLevelValue()
  formatLogMessage()
  collectLogs()

TFileLogRoute:: (10 méthodes):
  getLogPath()
  setLogPath()
  getLogFile()
  setLogFile()
  getMaxFileSize()
  setMaxFileSize()
  getMaxLogFiles()
  setMaxLogFiles()
  processLogs()
  rotateFiles()

TEmailLogRoute:: (8 méthodes):
  init()
  processLogs()
  getEmails()
  setEmails()
  getSubject()
  setSubject()
  getSentFrom()
  setSentFrom()

TBrowserLogRoute:: (5 méthodes):
  processLogs()
  renderHeader()
  renderMessage()
  getColorLevel()
  renderFooter()

Classe: TLogRouter - X-Ref

TLogRouter class.

TLogRouter manages routes that record log messages in different media different ways.
For example, a file log route {@link TFileLogRoute} records log messages
in log files. An email log route {@link TEmailLogRoute} sends log messages
to email addresses.

Log routes may be configured in application or page folder configuration files
or an external configuration file specified by {@link setConfigFile ConfigFile}.
The format is as follows,
<code>
<route class="TFileLogRoute" Categories="System.Web.UI" Levels="Warning" />
<route class="TEmailLogRoute" Categories="Application" Levels="Fatal" Emails="admin@pradosoft.com" />
</code>
You can specify multiple routes with different filtering conditions and different
targets, even if the routes are of the same type.

init($config) X-Ref

Initializes this module.
This method is required by the IModule interface.

param: TXmlElement configuration for this module, can be null

loadConfig($xml) X-Ref

Loads configuration from an XML element

param: TXmlElement configuration node

getConfigFile() X-Ref

return: string external configuration file. Defaults to null.

setConfigFile($value) X-Ref

param: string external configuration file in namespace format. The file

collectLogs($param) X-Ref

Collects log messages from a logger.
This method is an event handler to application's EndRequest event.

param: mixed event parameter

init($config) X-Ref

Initializes the route.

param: TXmlElement configurations specified in {@link TLogRouter}.

getLevels() X-Ref

return: integer log level filter

setLevels($levels) X-Ref

param: integer|string integer log level filter (in bits). If the value is

getCategories() X-Ref

return: array list of categories to be looked for

setCategories($categories) X-Ref

param: array|string list of categories to be looked for. If the value is a string,

getLevelName($level) X-Ref

param: integer level value
return: string level name

getLevelValue($level) X-Ref

param: string level name
return: integer level value

formatLogMessage($message,$level,$category,$time) X-Ref

Formats a log message given different fields.

param: string message content
param: integer message level
param: string message category
param: integer timestamp
return: string formatted message

collectLogs(TLogger $logger) X-Ref

Retrieves log messages from logger to log route specific destination.

param: TLogger logger instance

Classe: TFileLogRoute - X-Ref

TFileLogRoute class.

TFileLogRoute records log messages in files.
The log files are stored under {@link setLogPath LogPath} and the file name
is specified by {@link setLogFile LogFile}. If the size of the log file is
greater than {@link setMaxFileSize MaxFileSize} (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 {@link setMaxLogFiles MaxLogFiles}
specifies how many files to be kept.

getLogPath() X-Ref

return: string directory storing log files. Defaults to application runtime path.

setLogPath($value) X-Ref

param: string directory (in namespace format) storing log files.

getLogFile() X-Ref

return: string log file name. Defaults to 'prado.log'.

setLogFile($value) X-Ref

param: string log file name

getMaxFileSize() X-Ref

return: integer maximum log file size in kilo-bytes (KB). Defaults to 1024 (1MB).

setMaxFileSize($value) X-Ref

param: integer maximum log file size in kilo-bytes (KB).

getMaxLogFiles() X-Ref

return: integer number of files used for rotation. Defaults to 2.

setMaxLogFiles($value) X-Ref

param: integer number of files used for rotation.

processLogs($logs) X-Ref

Saves log messages in files.

param: array list of log messages

rotateFiles() X-Ref

Rotates log files.

Classe: TEmailLogRoute - X-Ref

TEmailLogRoute class.

TEmailLogRoute sends selected log messages to email addresses.
The target email addresses may be specified via {@link setEmails Emails} property.
Optionally, you may set the email {@link setSubject Subject} and the
{@link setSentFrom SentFrom} address.

init($config) X-Ref

Initializes the route.

param: TXmlElement configurations specified in {@link TLogRouter}.

processLogs($logs) X-Ref

Sends log messages to specified email addresses.

param: array list of log messages

getEmails() X-Ref

return: array list of destination email addresses

setEmails($emails) X-Ref

return: array|string list of destination email addresses. If the value is

getSubject() X-Ref

return: string email subject. Defaults to TEmailLogRoute::DEFAULT_SUBJECT

setSubject($value) X-Ref

param: string email subject.