Class CFileLogRoute

CFileLogRoute records log messages in files.

The log files are stored under setLogPath logPath and the file name is specified by setLogFile logFile. If the size of the log file is greater than 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 setMaxLogFiles maxLogFiles specifies how many files to be kept. If the property CFileLogRoute::$rotateByCopy is true, the primary log file will be rotated by a copy and truncated (to be more compatible with log tailers) otherwise it will be rotated by being renamed.

CComponent

CLogRoute

CFileLogRoute

Package: system\logging
Copyright: 2008-2013 Yii Software LLC
License: http://www.yiiframework.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 1.0
Located at x2engine/framework/logging/CFileLogRoute.php

Methods summary
`public`	# `init( )` Initializes the route. This method is invoked after the route is created by the route manager. Initializes the route. This method is invoked after the route is created by the route manager. Overrides `CLogRoute::init()`
`public string`	# `getLogPath( )` Returns `string` directory storing log files. Defaults to application runtime path.
`public`	# `setLogPath( string $value )` Parameters `$value` `string` $value directory for storing log files. Throws `CException` if the path is invalid
`public string`	# `getLogFile( )` Returns `string` log file name. Defaults to 'application.log'.
`public`	# `setLogFile( string $value )` Parameters `$value` `string` $value log file name
`public integer`	# `getMaxFileSize( )` Returns `integer` maximum log file size in kilo-bytes (KB). Defaults to 1024 (1MB).
`public`	# `setMaxFileSize( integer $value )` Parameters `$value` `integer` $value maximum log file size in kilo-bytes (KB).
`public integer`	# `getMaxLogFiles( )` Returns `integer` number of files used for rotation. Defaults to 5.
`public`	# `setMaxLogFiles( integer $value )` Parameters `$value` `integer` $value number of files used for rotation.
`protected`	# `processLogs( array $logs )` Saves log messages in files. Saves log messages in files. Parameters `$logs` `array` $logs list of log messages
`protected`	# `rotateFiles( )` Rotates log files. Rotates log files.

Methods inherited from CLogRoute
`collectLogs(), formatLogMessage()`

Methods inherited from CComponent
`__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()`

Properties summary
`public boolean`	`$rotateByCopy`	`false`	# Whether to rotate primary log by copy and truncate which is more compatible with log tailers. Defaults to false. Whether to rotate primary log by copy and truncate which is more compatible with log tailers. Defaults to false. Since 1.1.14

Properties inherited from CLogRoute
`$categories, $enabled, $except, $filter, $levels, $logs`

Magic properties summary
`public string`	`$logPath`	# Directory storing log files. Defaults to application runtime path. Directory storing log files. Defaults to application runtime path.
`public string`	`$logFile`	# Log file name. Defaults to 'application.log'. Log file name. Defaults to 'application.log'.
`public integer`	`$maxFileSize`	# Maximum log file size in kilo-bytes (KB). Defaults to 1024 (1MB). Maximum log file size in kilo-bytes (KB). Defaults to 1024 (1MB).
`public integer`	`$maxLogFiles`	# Number of files used for rotation. Defaults to 5. Number of files used for rotation. Defaults to 5.

Packages

Classes

Interfaces

Class CFileLogRoute

Overrides

Returns

Parameters

Throws

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Since