Class yii\log\DbTarget

Inheritanceyii\log\DbTarget » yii\log\Target » yii\base\Component » yii\base\BaseObject
Implementsyii\base\Configurable
Available since version2.0
Source Code https://github.com/yiisoft/yii2/blob/master/framework/log/DbTarget.php

DbTarget stores log messages in a database table.

The database connection is specified by $db. Database schema could be initialized by applying migration:

yii migrate --migrationPath=@yii/log/migrations/

If you don't want to use migration and need SQL instead, files for all databases are in migrations directory.

You may change the name of the table used to store the data by setting $logTable.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$categories array List of message categories that this target is interested in. yii\log\Target
$db yii\db\Connection|array|string The DB connection object or the application component ID of the DB connection. yii\log\DbTarget
$except array List of message categories that this target is NOT interested in. yii\log\Target
$exportInterval integer How many messages should be accumulated before they are exported. yii\log\Target
$logTable string Name of the DB table to store cache content. yii\log\DbTarget
$logVars array List of the PHP predefined variables that should be logged in a message. yii\log\Target
$messages array The messages that are retrieved from the logger so far by this log target. yii\log\Target
$microtime boolean Whether to log time with microseconds. yii\log\Target
$prefix callable A PHP callable that returns a string to be prefixed to every exported message. yii\log\Target

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of an object property. yii\base\BaseObject
__isset() Checks if a property is set, i.e. defined and not null. yii\base\BaseObject
__set() Sets value of an object property. yii\base\BaseObject
__unset() Sets an object property to null. yii\base\BaseObject
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
canGetProperty() Returns a value indicating whether a property can be read. yii\base\BaseObject
canSetProperty() Returns a value indicating whether a property can be set. yii\base\BaseObject
className() Returns the fully qualified name of this class. yii\base\BaseObject
collect() Processes the given log messages. yii\log\Target
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
export() Stores log messages to DB. yii\log\DbTarget
filterMessages() Filters the given messages according to their categories and levels. yii\log\Target
formatMessage() Formats a log message for display as a string. yii\log\Target
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
getEnabled() Check whether the log target is enabled. yii\log\Target
getLevels() yii\log\Target
getMessagePrefix() Returns a string to be prefixed to the given message. yii\log\Target
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event. yii\base\Component
hasMethod() Returns a value indicating whether a method is defined. yii\base\BaseObject
hasProperty() Returns a value indicating whether a property is defined. yii\base\BaseObject
init() Initializes the DbTarget component. yii\log\DbTarget
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
setEnabled() Sets a value indicating whether this log target is enabled. yii\log\Target
setLevels() Sets the message levels that this target is interested in. yii\log\Target
trigger() Triggers an event. yii\base\Component

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
getContextMessage() Generates the context information to be logged. yii\log\Target
getTime() Returns formatted ('Y-m-d H:i:s') timestamp for message. yii\log\Target

Property Details

$db public property

The DB connection object or the application component ID of the DB connection. After the DbTarget object is created, if you want to change this property, you should only assign it with a DB connection object. Starting from version 2.0.2, this can also be a configuration array for creating the object.

$logTable public property

Name of the DB table to store cache content. Defaults to "log".

public string $logTable '{{%log}}'

Method Details

export() public method

Stores log messages to DB.

public void export ( )
init() public method

Initializes the DbTarget component.

This method will initialize the $db property to make sure it refers to a valid DB connection.

public void init ( )
throws yii\base\InvalidConfigException

if $db is invalid.