Class yii\debug\LogTarget
| Inheritance | yii\debug\LogTarget » yii\log\Target » yii\base\Component » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2-debug/blob/master/LogTarget.php |
The debug LogTarget is used to store logs for later use in the debugger tool
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $categories | array | List of message categories that this target is interested in. | 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 |
| $logVars | array | List of the PHP predefined variables that should be logged in a message. | yii\log\Target |
| $maskVars | array | 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. |
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 |
| $module | yii\debug\Module | yii\debug\LogTarget | |
| $prefix | callable | A PHP callable that returns a string to be prefixed to every exported message. | yii\log\Target |
| $tag | string | yii\debug\LogTarget |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __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 |
| __construct() | yii\debug\LogTarget | |
| __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() | Returns the fully qualified name of this class. | yii\base\BaseObject |
| collect() | Processes the given log messages. | yii\debug\LogTarget |
| 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() | Exports log messages to a specific destination. | yii\debug\LogTarget |
| 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\Component |
| hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
| init() | Initializes the object. | yii\base\BaseObject |
| 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
| Method | Description | Defined By |
|---|---|---|
| collectSummary() | Collects summary data of current request. | yii\debug\LogTarget |
| gc() | Removes obsolete data files | yii\debug\LogTarget |
| getContextMessage() | Generates the context information to be logged. | yii\log\Target |
| getSqlTotalCount() | Returns total sql count executed in current request. If database panel is not configured returns 0. | yii\debug\LogTarget |
| getTime() | Returns formatted ('Y-m-d H:i:s') timestamp for message. | yii\log\Target |
| removeStaleDataFiles() | Remove staled data files i.e. files that are not in the current index file (may happen because of corrupted or rotated index file) | yii\debug\LogTarget |
Property Details
Method Details
| public void __construct ( $module, $config = [] ) | ||
| $module | yii\debug\Module | |
| $config | array | |
Processes the given log messages.
This method will filter the given messages with \yii\debug\levels and $categories. And if requested, it will also export the filtering result to specific medium (e.g. email).
| public void collect ( $messages, $final ) | ||
| $messages | array | Log messages to be processed. See yii\log\Logger::$messages for the structure of each message. |
| $final | boolean | Whether this method is called at the end of the current application |
| throws | yii\base\Exception | |
|---|---|---|
Collects summary data of current request.
| protected array collectSummary ( ) |
Exports log messages to a specific destination.
Child classes must implement this method.
| public void export ( ) | ||
| throws | yii\base\Exception | |
|---|---|---|
Removes obsolete data files
| protected void gc ( &$manifest ) | ||
| $manifest | array | |
Returns total sql count executed in current request. If database panel is not configured returns 0.
| protected integer getSqlTotalCount ( ) |
Remove staled data files i.e. files that are not in the current index file (may happen because of corrupted or rotated index file)
| protected void removeStaleDataFiles ( $manifest ) | ||
| $manifest | array | |