Abstract Class yii\log\Target

Target is the base class for all log target classes.

A log target object will filter the messages logged by yii\log\Logger according to its $levels and $categories properties. It may also export the filtered messages to specific destination defined by the target, such as emails, files.

Level filter and category filter are combinatorial, i.e., only messages satisfying both filter conditions will be handled. Additionally, you may specify $except to exclude messages of certain categories.

Public Properties

Public Methods

Protected Methods

Property Details

$categories public property

List of message categories that this target is interested in. Defaults to empty, meaning all categories. You can use an asterisk at the end of a category so that the category may be used to match those categories sharing the same common prefix. For example, 'yii\db*' will match categories starting with 'yii\db\', such as 'yii\db\Connection'.

public array $categories = []

$enabled public property

Whether to enable this log target. Defaults to true.

public boolean $enabled = true

$except public property

List of message categories that this target is NOT interested in. Defaults to empty, meaning no uninteresting messages. If this property is not empty, then any category listed here will be excluded from $categories. You can use an asterisk at the end of a category so that the category can be used to match those categories sharing the same common prefix. For example, 'yii\db*' will match categories starting with 'yii\db\', such as 'yii\db\Connection'.

See also $categories.

public array $except = []

$exportInterval public property

How many messages should be accumulated before they are exported. Defaults to 1000. Note that messages will always be exported when the application terminates. Set this property to be 0 if you don't want to export messages until the application terminates.

public integer $exportInterval = 1000

$levels public property

The message levels that this target is interested in. This is a bitmap of level values. Defaults to 0, meaning all available levels.

public integer getLevels ( )
public void setLevels ( $levels )

$logVars public property

List of the PHP predefined variables that should be logged in a message. Note that a variable must be accessible via $GLOBALS. Otherwise it won't be logged.

Defaults to ['_GET', '_POST', '_FILES', '_COOKIE', '_SESSION', '_SERVER'].

Since version 2.0.9 additional syntax can be used: Each element could be specified as one of the following:

• var - var will be logged.
• var.key - only var[key] key will be logged.
• !var.key - var[key] key will be excluded.

See also yii\helpers\ArrayHelper::filter().

public array $logVars = ['_GET', '_POST', '_FILES', '_COOKIE', '_SESSION', '_SERVER']

$messages public property

The messages that are retrieved from the logger so far by this log target. Please refer to yii\log\Logger::$messages for the details about the message structure.

public array $messages = []

$prefix public property

A PHP callable that returns a string to be prefixed to every exported message.

If not set, getMessagePrefix() will be used, which prefixes the message with context information such as user IP, user ID and session ID.

The signature of the callable should be function ($message).

public callable $prefix = null

Method Details

['error', 'warning']
// which is equivalent to:
Logger::LEVEL_ERROR | Logger::LEVEL_WARNING