W3cubDocs

/Yii 2.0

Class yii\debug\LogTarget

Inheritance yii\debug\LogTarget » 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-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
$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
$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
$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
$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 yii\debug\LogTarget

Public Methods

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() yii\debug\LogTarget
__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\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
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 object. yii\base\Object
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

Protected Methods

Method Description Defined By
collectSummary() Collects summary data of current request. yii\debug\LogTarget
gc() 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

Property Details

$module public property

public yii\debug\Module $module = null

$tag public property

public  $tag = null

Method Details

__construct() public method

public void __construct ( $module, $config = [] )
$module yii\debug\Module
$config array

collect() public method

Processes the given log messages.

This method will filter the given messages with $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

collectSummary() protected method

Collects summary data of current request.

protected array collectSummary ( )

export() public method

Exports log messages to a specific destination.

Child classes must implement this method.

public void export ( )

gc() protected method

protected void gc ( &$manifest )
$manifest

getSqlTotalCount() protected method

Returns total sql count executed in current request. If database panel is not configured returns 0.

protected integer getSqlTotalCount ( )

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-debug-logtarget.html