DbTarget

API reference › yii › log › DbTarget

class	`yii\log\DbTarget`
Extends	`Target` » `yii\base\Component` » `yii\base\BaseObject`
Implements	`yii\base\Configurable`
Since	2.0
Source	`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.

Properties

Property	Type	Description	Defined by
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$categories`	`list<string>`	List of message categories that this target is interested in. Default: `[]`.	`Target`
`$db`	`yii\db\Connection\|array\|string`	The DB connection object or the application component ID of the DB connection. Default: `'db'`.	`DbTarget`
`$enabled`	`bool\|callable`	A boolean value or a callable to obtain the value from.	`Target`
`$except`	`list<string>`	List of message categories that this target is NOT interested in. Default: `[]`.	`Target`
`$exportInterval`	`int`	How many messages should be accumulated before they are exported. Default: `1000`.	`Target`
`$levels`	`array\|int`	Message levels that this target is interested in.	`Target`
`$logTable`	`string`	Name of the DB table to store cache content. Default: `'{{%log}}'`.	`DbTarget`
`$logVars`	`list<string>`	List of the PHP predefined variables that should be logged in a message. Default: `['_GET', '_POST', '_FILES', '_COOKIE', '_SESSION', '_SERVER']`.	`Target`
`$maskVars`	`list<string>`	List of the PHP predefined variables that should NOT be logged “as is” and should always be replaced with a mask `***` before logging, when exist. Default: `['_SERVER.HTTP_AUTHORIZATION', '_SERVER.PHP_AUTH_USER', '_SERVER.PHP_AUTH_PW']`. Available since 2.0.16.	`Target`
`$messages`	`list<yii\log\LogMessage>`	The messages that are retrieved from the logger so far by this log target. Default: `[]`.	`Target`
`$microtime`	`bool`	Whether to log time with microseconds. Default: `false`. Available since 2.0.13.	`Target`
`$prefix`	`callable(yii\log\LogMessage): string\|null`	A PHP callable that returns a string to be prefixed to every exported message. Default: `null`.	`Target`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`yii\base\Component`
`__clone()`	This method is called after the object is created by cloning an existing one.	`yii\base\Component`
`__get()`	Returns the value of a component property.	`yii\base\Component`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\Component`
`__set()`	Sets the value of a component property.	`yii\base\Component`
`__unset()`	Sets a component property to be null.	`yii\base\Component`
`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\Component`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\Component`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`collect()`	Processes the given log messages.	`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.	`DbTarget`
`filterMessages()` static	Filters the given messages according to their categories and levels.	`Target`
`formatMessage()`	Formats a log message for display as a string.	`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.	`Target`
`getLevels()`		`Target`
`getMessagePrefix()`	Returns a string to be prefixed to the given message.	`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\Component`
`hasProperty()`	Returns a value indicating whether a property is defined for this component.	`yii\base\Component`
`init()`	Initializes the DbTarget component.	`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.	`Target`
`setLevels()`	Sets the message levels that this target is interested in.	`Target`
`trigger()`	Triggers an event.	`yii\base\Component`
`formatMessageText()` protected	Converts a log message value to text.	`Target`
`getContextMessage()` protected	Generates the context information to be logged.	`Target`
`getTime()` protected	Returns formatted (‘Y-m-d H:i:s’) timestamp for message.	`Target`

Property details

$db

public yii\db\Connection|array|string $db = 'db'

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 string $logTable = '{{%log}}'

Name of the DB table to store cache content.

Defaults to “log”.

Method details

export()

public function export(): mixed

Stores log messages to DB.

Starting from version 2.0.14, this method throws LogRuntimeException in case the log can not be exported.

Returns

mixed

Throws

init()

public function init(): mixed

Initializes the DbTarget component.

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

Returns

mixed

Throws

yii\base\InvalidConfigException: if $db is invalid.