CLogFilter

Подробное описание свойств

context свойство только для чтения

protected string getContext()

Генерирует контекстную информацию для регистрации. По умолчанию реализация выводит информацию о пользователе, системные переменные и т.д.

dumper свойство (доступно начиная с v1.1.14)

public callable $dumper;

или функция, которая будет использоваться для вывода контекстной информации. По умолчанию используется `var_export`. Если у вас возникают проблемы с циклическими ссылками, измените её на `print_r`. Можно использовать любой тип вызываемого объекта (статические методы, пользовательские функции, лямбды и т.д.).

logUser свойство

public boolean $logUser;

указывает, нужно ли регистрировать имя и идентификатор текущего пользователя. По умолчанию true.

logVars свойство

public array $logVars;

список предопределённых переменных PHP, которые необходимо регистрировать. Обратите внимание, что переменная должна быть доступна через $GLOBALS. В противном случае она не будет зарегистрирована.

prefixSession свойство

public boolean $prefixSession;

указывает, нужно ли добавлять в начало каждого сообщения журнала идентификатор текущей сессии пользователя. По умолчанию false.

prefixUser свойство

public boolean $prefixUser;

указывает, нужно ли добавлять в начало каждого сообщения журнала имя и идентификатор текущего пользователя (name и ID). По умолчанию false.

Подробное описание методов

filter() метод

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;
}

Фильтрует заданные сообщения журнала. Это основной метод CLogFilter. Он обрабатывает сообщения журнала, добавляя контекстную информацию и т.д.

format() метод

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];
    }
}

Форматирует записи журнала. По умолчанию каждая запись префиксруется идентификатором сессии, если prefixSession имеет значение true. Также, если prefixUser имеет значение true, каждая запись может префиксроваться именем и идентификатором текущего пользователя.

getContext() метод

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);
}

Генерирует информацию о контексте для записи в журнал. По умолчанию реализация выводит информацию о пользователе, системных переменных и т. д.