CDbLogRoute

Package	system.logging
Inheritance	class CDbLogRoute » CLogRoute » CComponent
Since	1.0
Source Code	framework/logging/CDbLogRoute.php

CDbLogRoute stores log messages in a database table.

To specify the database table for storing log messages, set logTableName as the name of the table and specify connectionID to be the ID of a CDbConnection application component. If they are not set, a SQLite3 database named 'log-YiiVersion.db' will be created and used under the application runtime directory.

Public Properties

Property	Type	Description	Defined By
autoCreateLogTable	boolean	whether the log DB table should be automatically created if not exists.	CDbLogRoute
categories	mixed	array of categories, or string list separated by comma or space.	CLogRoute
connectionID	string	the ID of CDbConnection application component.	CDbLogRoute
enabled	boolean	whether to enable this log route.	CLogRoute
except	mixed	array of categories, or string list separated by comma or space, to EXCLUDE from logs.	CLogRoute
filter	mixed	the additional filter (eg CLogFilter) that can be applied to the log messages.	CLogRoute
levels	string	list of levels separated by comma or space.	CLogRoute
logTableName	string	the name of the DB table that stores log content.	CDbLogRoute
logs	array	the logs that are collected so far by this log route.	CLogRoute

Protected Properties

Property	Type	Description	Defined By
dbConnection	CDbConnection	the DB connection instance	CDbLogRoute

Public 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
collectLogs()	Retrieves filtered log messages from logger for further processing.	CLogRoute
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
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
init()	Initializes the route.	CDbLogRoute
raiseEvent()	Raises an event.	CComponent

Protected Methods

Method	Description	Defined By
createLogTable()	Creates the DB table for storing log messages.	CDbLogRoute
formatLogMessage()	Formats a log message given different fields.	CLogRoute
getDbConnection()	Returns the DB connection instance	CDbLogRoute
processLogs()	Stores log messages into database.	CDbLogRoute

Property Details

autoCreateLogTable property

public boolean $autoCreateLogTable;

whether the log DB table should be automatically created if not exists. Defaults to true.

connectionID property

public string $connectionID;

the ID of CDbConnection application component. If not set, a SQLite database will be automatically created and used. The SQLite database file is protected/runtime/log-YiiVersion.db.

dbConnection property read-only

protected CDbConnection getDbConnection()

the DB connection instance

logTableName property

public string $logTableName;

the name of the DB table that stores log content. Defaults to 'YiiLog'. If autoCreateLogTable is false and you want to create the DB table manually by yourself, you need to make sure the DB table is of the following structure:

 (
	id       INTEGER NOT NULL PRIMARY KEY,
	level    VARCHAR(128),
	category VARCHAR(128),
	logtime  INTEGER,
	message  TEXT
  )

Note, the 'id' column must be created as an auto-incremental column. In MySQL, this means it should be id INTEGER NOT NULL AUTO_INCREMENT PRIMARY KEY; In PostgreSQL, it is id SERIAL PRIMARY KEY.

Method Details

createLogTable() method

protected void createLogTable(CDbConnection $db, string $tableName)
$db	CDbConnection	the database connection
$tableName	string	the name of the table to be created

Source Code: framework/logging/CDbLogRoute.php#88 (show)

protected function createLogTable($db,$tableName)
{
    $db->createCommand()->createTable($tableName, array(
        'id'=>'pk',
        'level'=>'varchar(128)',
        'category'=>'varchar(128)',
        'logtime'=>'integer',
        'message'=>'text',
    ));
}

Creates the DB table for storing log messages.

getDbConnection() method

protected CDbConnection getDbConnection()
{return}	CDbConnection	the DB connection instance

Source Code: framework/logging/CDbLogRoute.php#103 (show)

protected function getDbConnection()
{
    if($this->_db!==null)
        return $this->_db;
    elseif(($id=$this->connectionID)!==null)
    {
        if(($this->_db=Yii::app()->getComponent($id)) instanceof CDbConnection)
            return $this->_db;
        else
            throw new CException(Yii::t('yii','CDbLogRoute.connectionID "{id}" does not point to a valid CDbConnection application component.',
                array('{id}'=>$id)));
    }
    else
    {
        $dbFile=Yii::app()->getRuntimePath().DIRECTORY_SEPARATOR.'log-'.Yii::getVersion().'.db';
        return $this->_db=new CDbConnection('sqlite:'.$dbFile);
    }
}

init() method

public void init()

Source Code: framework/logging/CDbLogRoute.php#65 (show)

public function init()
{
    parent::init();

    if($this->autoCreateLogTable)
    {
        $db=$this->getDbConnection();
        try
        {
            $db->createCommand()->delete($this->logTableName,'0=1');
        }
        catch(Exception $e)
        {
            $this->createLogTable($db,$this->logTableName);
        }
    }
}

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

processLogs() method

protected void processLogs(array $logs)
$logs	array	list of log messages

Source Code: framework/logging/CDbLogRoute.php#126 (show)

protected function processLogs($logs)
{
    $command=$this->getDbConnection()->createCommand();
    foreach($logs as $log)
    {
        $command->insert($this->logTableName,array(
            'level'=>$log[1],
            'category'=>$log[2],
            'logtime'=>(int)$log[3],
            'message'=>$log[0],
        ));
    }
}

Stores log messages into database.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CDbLogRoute