Inheritance | yii\log\DbTarget » yii\log\Target » yii\base\Component » yii\base\Object |
---|---|
Implements | yii\base\Configurable |
Available since version | 2.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.
Property | Type | Description | Defined By |
---|---|---|---|
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component | yii\base\Component |
$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 |
$enabled | boolean | Whether to enable this log target. | yii\log\Target |
$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 |
$levels | integer | The message levels that this target is interested in. | 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 |
$prefix | callable | A PHP callable that returns a string to be prefixed to every exported message. | yii\log\Target |
Method | Description | Defined By |
---|---|---|
__call() | Calls the named method which is not a class method. | yii\base\Object |
__clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
__construct() | Constructor. | yii\base\Object |
__get() | Returns the value of an object property. | yii\base\Object |
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Object |
__set() | Sets value of an object property. | yii\base\Object |
__unset() | Sets an object property to null. | yii\base\Object |
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\Object |
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Object |
className() | Returns the fully qualified name of this class. | yii\base\Object |
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 |
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\Object |
hasProperty() | Returns a value indicating whether a property is defined. | yii\base\Object |
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 |
setLevels() | Sets the message levels that this target is interested in. | yii\log\Target |
trigger() | Triggers an event. | yii\base\Component |
Method | Description | Defined By |
---|---|---|
getContextMessage() | Generates the context information to be logged. | yii\log\Target |
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.
public yii\db\Connection|array|string $db = 'db'
Name of the DB table to store cache content. Defaults to "log".
public string $logTable = '{{%log}}'
Stores log messages to DB.
public void export ( ) |
---|
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. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-log-dbtarget.html