CLogRoute

Property Details

categories property

public mixed $categories;

array of categories, or string list separated by comma or space. Defaults to empty array, meaning all categories.

enabled property

public boolean $enabled;

whether to enable this log route. Defaults to true.

except property

public mixed $except;

array of categories, or string list separated by comma or space, to EXCLUDE from logs. Defaults to empty array, meaning no categories are excluded. This will exclude any categories after $categories has been ran.

filter property

public mixed $filter;

the additional filter (eg CLogFilter) that can be applied to the log messages. The value of this property will be passed to Yii::createComponent to create a log filter object. As a result, this can be either a string representing the filter class name or an array representing the filter configuration. In general, the log filter class should implement ILogFilter interface. If you want to apply multiple filters you can use CChainedLogFilter to do so. Defaults to null, meaning no filter will be used.

levels property

public string $levels;

list of levels separated by comma or space. Defaults to empty, meaning all levels.

logs property (available since v1.1.0)

public array $logs;

the logs that are collected so far by this log route.

Method Details

collectLogs() method

public void collectLogs(CLogger $logger, boolean $processLogs=false)

public function collectLogs($logger, $processLogs=false)
{
    $logs=$logger->getLogs($this->levels,$this->categories,$this->except);
    $this->logs=empty($this->logs) ? $logs : array_merge($this->logs,$logs);
    if($processLogs && !empty($this->logs))
    {
        if($this->filter!==null)
            Yii::createComponent($this->filter)->filter($this->logs);
        if($this->logs!==array())
            $this->processLogs($this->logs);
        $this->logs=array();
    }
}

Retrieves filtered log messages from logger for further processing.

formatLogMessage() method

protected string formatLogMessage(string $message, integer $level, string $category, integer $time)

protected function formatLogMessage($message,$level,$category,$time)
{
    return @date('Y/m/d H:i:s',$time)." [$level] [$category] $message\n";
}

Formats a log message given different fields.

init() method

public void init()

public function init()
{
}

Initializes the route. This method is invoked after the route is created by the route manager.

processLogs() method

abstract protected void processLogs(array $logs)

abstract protected function processLogs($logs);

Processes log messages and sends them to specific destination. Derived child classes must implement this method.