yii\mongodb\log\MongoDbTarget - Yii2 类参考手册

Class yii\mongodb\log\MongoDbTarget

Inheritanceyii\mongodb\log\MongoDbTarget » yii\log\Target » yii\base\Component » yii\base\BaseObject
Implementsyii\base\Configurable
Available since version2.0

MongoDbTarget stores log messages in a MongoDB collection.

By default, MongoDbTarget stores the log messages in a MongoDB collection named 'log'. The collection can be changed by setting the $logCollection property.

Public Properties

隐藏继承的属性 Hide inherited 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
$db yii\mongodb\Connection|string The MongoDB connection object or the application component ID of the MongoDB connection. yii\mongodb\log\MongoDbTarget
$enabled boolean|callable A boolean value or a callable to obtain the value from. 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
$logCollection string|array The name of the MongoDB collection that stores the session data. yii\mongodb\log\MongoDbTarget
$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
$prefix callable A PHP callable that returns a string to be prefixed to every exported message. yii\log\Target

Public Methods

隐藏继承的方法 Hide inherited methods

方法 Method简介 Description定义在 Defined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of an object property. yii\base\BaseObject
__isset() Checks if a property is set, i.e. defined and not null. yii\base\BaseObject
__set() Sets value of an object property. yii\base\BaseObject
__unset() Sets an object property to null. yii\base\BaseObject
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\BaseObject
canSetProperty() Returns a value indicating whether a property can be set. yii\base\BaseObject
className() Returns the fully qualified name of this class. yii\base\BaseObject
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 MongoDB collection. yii\mongodb\log\MongoDbTarget
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\BaseObject
hasProperty() Returns a value indicating whether a property is defined. yii\base\BaseObject
init() Initializes the MongoDbTarget component. yii\mongodb\log\MongoDbTarget
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

隐藏继承的方法 Hide inherited methods

方法 Method简介 Description定义在 Defined By
getContextMessage() Generates the context information to be logged. yii\log\Target
getTime() Returns formatted ('Y-m-d H:i:s') timestamp for message. yii\log\Target

属性详情 Property Details

$db public property

The MongoDB connection object or the application component ID of the MongoDB connection. After the MongoDbTarget object is created, if you want to change this property, you should only assign it with a MongoDB connection object.

public yii\mongodb\Connection|string $db 'mongodb'
$logCollection public property

The name of the MongoDB collection that stores the session data. Please refer to yii\mongodb\Connection::getCollection() on how to specify this parameter. This collection is better to be pre-created with fields 'id' and 'expire' indexed.

public string|array $logCollection 'log'

方法详情 Method Details

export() public method

Stores log messages to MongoDB collection.

public void export ( )
init() public method

Initializes the MongoDbTarget component.

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

public void init ( )
throws yii\base\InvalidConfigException

if $db is invalid.