Home » Documentation » Class Reference » CLogFilter

CLogFilter

Package	system.logging
Inheritance	class CLogFilter » CComponent
Since	1.0.6
Version	$Id: CLogFilter.php 1678 2010-01-07 21:02:00Z qiang.xue $

CLogFilter preprocesses the logged messages before they are handled by a log route.

CLogFilter is meant to be used by a log route to preprocess the logged messages before they are handled by the route. The default implementation of CLogFilter prepends additional context information to the logged messages. In particular, by setting logVars, predefined PHP variables such as $_SERVER, $_POST, etc. can be saved as a log message, which may help identify/debug issues encountered.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
logUser	boolean	whether to log the current user name and ID.	CLogFilter
logVars	array	list of the PHP predefined variables that should be logged.	CLogFilter
prefixSession	boolean	whether to prefix each log message with the current user session ID.	CLogFilter
prefixUser	boolean	whether to prefix each log message with the current user name and ID.	CLogFilter

Protected Properties

Hide inherited properties

Property	Type	Description	Defined By
context	string	Generates the context information to be logged.	CLogFilter

Public Methods

Hide inherited 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
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
filter()	Filters the given log messages.	CLogFilter
getEventHandlers()	Returns the list of attached event handlers for an event.	CComponent
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
raiseEvent()	Raises an event.	CComponent

Protected Methods

Hide inherited methods

Method	Description	Defined By
format()	Formats the log messages.	CLogFilter
getContext()	Generates the context information to be logged.	CLogFilter

Property Details

context property read-only

protected string getContext()

Generates the context information to be logged. The default implementation will dump user information, system variables, etc.

logUser property

public boolean $logUser;

whether to log the current user name and ID. Defaults to true. This property is effective only when showContext is true.

logVars property

public array $logVars;

list of the PHP predefined variables that should be logged. Note that a variable must be accessible via $GLOBALS. Otherwise it won't be logged.

prefixSession property

public boolean $prefixSession;

whether to prefix each log message with the current user session ID. Defaults to false.

prefixUser property

public boolean $prefixUser;

whether to prefix each log message with the current user name and ID. Defaults to false.

Method Details

filter() method

public void filter(array $logs)
$logs	array	the log messages

Filters the given log messages. This is the main method of CLogFilter. It processes the log messages by adding context information, etc.

format() method

protected void format($logs)
$logs

Formats the log messages. The default implementation will prefix each message with session ID if prefixSession is set true. It may also prefix each message with the current user's name and ID if prefixUser is true.

getContext() method

protected string getContext()
{return}	string	the context information. If an empty string, it means no context information.