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.

dumper property (available since v1.1.14)

public callable $dumper;

or function which will be used to dump context information. Defaults to `var_export`. If you're experiencing issues with circular references problem change it to `print_r`. Any kind of callable (static methods, user defined functions, lambdas, etc.) could also be used.

logUser property

public boolean $logUser;

whether to log the current user name and ID. Defaults to 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 array filter(array &$logs)

public function filter(&$logs)
{
    if (!empty($logs))
    {
        if(($message=$this->getContext())!=='')
            array_unshift($logs,array($message,CLogger::LEVEL_INFO,'application',YII_BEGIN_TIME));
        $this->format($logs);
    }
    return $logs;
}

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(array &$logs)

protected function format(&$logs)
{
    $prefix='';
    if($this->prefixSession && ($id=session_id())!=='')
        $prefix.="[$id]";
    if($this->prefixUser && ($user=Yii::app()->getComponent('user',false))!==null)
        $prefix.='['.$user->getName().']['.$user->getId().']';
    if($prefix!=='')
    {
        foreach($logs as &$log)
            $log[0]=$prefix.' '.$log[0];
    }
}

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()

protected function getContext()
{
    $context=array();
    if($this->logUser && ($user=Yii::app()->getComponent('user',false))!==null)
        $context[]='User: '.$user->getName().' (ID: '.$user->getId().')';

    if($this->dumper==='var_export' || $this->dumper==='print_r')
    {
        foreach($this->logVars as $name)
            if(($value=$this->getGlobalsValue($name))!==null)
                $context[]="\${$name}=".call_user_func($this->dumper,$value,true);
    }
    else
    {
        foreach($this->logVars as $name)
            if(($value=$this->getGlobalsValue($name))!==null)
                $context[]="\${$name}=".call_user_func($this->dumper,$value);
    }

    return implode("\n\n",$context);
}

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