CFileLogRoute
| Package | system.logging |
|---|---|
| Inheritance | class CFileLogRoute » CLogRoute » CComponent |
| Since | 1.0 |
| Version | $Id: CFileLogRoute.php 1678 2010-01-07 21:02:00Z qiang.xue $ |
CFileLogRoute records log messages in files.
The log files are stored under logPath and the file name is specified by logFile. If the size of the log file is greater than 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 maxLogFiles specifies how many files to be kept.
The log files are stored under logPath and the file name is specified by logFile. If the size of the log file is greater than 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 maxLogFiles specifies how many files to be kept.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| categories | string | list of categories separated by comma or space. | CLogRoute |
| enabled | boolean | whether to enable this log route. | CLogRoute |
| filter | mixed | the additional filter (e. | CLogRoute |
| levels | string | list of levels separated by comma or space. | CLogRoute |
| logFile | string | log file name. | CFileLogRoute |
| logPath | string | directory storing log files. | CFileLogRoute |
| logs | array | the logs that are collected so far by this log route. | CLogRoute |
| maxFileSize | integer | maximum log file size in kilo-bytes (KB). | CFileLogRoute |
| maxLogFiles | integer | number of files used for rotation. | CFileLogRoute |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | CComponent |
| __get() | Returns a property value, an event handler list or a behavior based on its name. | CComponent |
| __isset() | Checks if a property value is null. | CComponent |
| __set() | Sets value of a component property. | CComponent |
| __unset() | Sets a component property to be null. | CComponent |
| asa() | Returns the named behavior object. | CComponent |
| attachBehavior() | Attaches a behavior to this component. | CComponent |
| attachBehaviors() | Attaches a list of behaviors to the component. | CComponent |
| attachEventHandler() | Attaches an event handler to an event. | CComponent |
| canGetProperty() | Determines whether a property can be read. | CComponent |
| canSetProperty() | Determines whether a property can be set. | CComponent |
| collectLogs() | Retrieves filtered log messages from logger for further processing. | CLogRoute |
| detachBehavior() | Detaches a behavior from the component. | CComponent |
| detachBehaviors() | Detaches all behaviors from the component. | CComponent |
| detachEventHandler() | Detaches an existing event handler. | CComponent |
| disableBehavior() | Disables an attached behavior. | CComponent |
| disableBehaviors() | Disables all behaviors attached to this component. | CComponent |
| enableBehavior() | Enables an attached behavior. | CComponent |
| enableBehaviors() | Enables all behaviors attached to this component. | CComponent |
| evaluateExpression() | Evaluates a PHP expression or callback under the context of this component. | CComponent |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| getLogFile() | CFileLogRoute | |
| getLogPath() | CFileLogRoute | |
| getMaxFileSize() | CFileLogRoute | |
| getMaxLogFiles() | CFileLogRoute | |
| hasEvent() | Determines whether an event is defined. | CComponent |
| hasEventHandler() | Checks whether the named event has attached handlers. | CComponent |
| hasProperty() | Determines whether a property is defined. | CComponent |
| init() | Initializes the route. | CFileLogRoute |
| raiseEvent() | Raises an event. | CComponent |
| setLogFile() | CFileLogRoute | |
| setLogPath() | CFileLogRoute | |
| setMaxFileSize() | CFileLogRoute | |
| setMaxLogFiles() | CFileLogRoute |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| formatLogMessage() | Formats a log message given different fields. | CLogRoute |
| processLogs() | Saves log messages in files. | CFileLogRoute |
| rotateFiles() | Rotates log files. | CFileLogRoute |
Property Details
logFile
property
log file name. Defaults to 'application.log'.
logPath
property
directory storing log files. Defaults to application runtime path.
maxFileSize
property
maximum log file size in kilo-bytes (KB). Defaults to 1024 (1MB).
maxLogFiles
property
number of files used for rotation. Defaults to 5.
Method Details
getLogFile()
method
|
public string getLogFile()
| ||
| {return} | string | log file name. Defaults to 'application.log'. |
getLogPath()
method
|
public string getLogPath()
| ||
| {return} | string | directory storing log files. Defaults to application runtime path. |
getMaxFileSize()
method
|
public integer getMaxFileSize()
| ||
| {return} | integer | maximum log file size in kilo-bytes (KB). Defaults to 1024 (1MB). |
getMaxLogFiles()
method
|
public integer getMaxLogFiles()
| ||
| {return} | integer | number of files used for rotation. Defaults to 5. |
init()
method
|
public void init()
|
Initializes the route. This method is invoked after the route is created by the route manager.
processLogs()
method
|
protected void processLogs(array $logs)
| ||
| $logs | array | list of log messages |
Saves log messages in files.
rotateFiles()
method
|
protected void rotateFiles()
|
Rotates log files.
setLogFile()
method
|
public void setLogFile(string $value)
| ||
| $value | string | log file name |
setLogPath()
method
|
public void setLogPath(string $value)
| ||
| $value | string | directory for storing log files. |
setMaxFileSize()
method
|
public void setMaxFileSize(integer $value)
| ||
| $value | integer | maximum log file size in kilo-bytes (KB). |
setMaxLogFiles()
method
|
public void setMaxLogFiles(integer $value)
| ||
| $value | integer | number of files used for rotation. |