Class yii\log\EmailTarget

继承yii\log\EmailTarget » yii\log\Target » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable
可用自版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/log/EmailTarget.php

EmailTarget sends selected log messages to the specified email addresses.

You may configure the email to be sent by setting the $message property, through which you can set the target email addresses, subject, etc.:

'components' => [
    'log' => [
         'targets' => [
             [
                 'class' => 'yii\log\EmailTarget',
                 'mailer' => 'mailer',
                 'levels' => ['error', 'warning'],
                 'message' => [
                     'from' => ['log@example.com'],
                     'to' => ['developer1@example.com', 'developer2@example.com'],
                     'subject' => 'Log message',
                 ],
             ],
         ],
    ],
],

In the above mailer is ID of the component that sends email and should be already configured.

公共属性

隐藏继承的属性

属性类型描述定义在
$behaviors yii\base\Behavior[] 附加到此组件的行为列表. yii\base\Component
$categories array List of message categories that this target is interested in. yii\log\Target
$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
$logVars array List of the PHP predefined variables that should be logged in a message. yii\log\Target
$mailer yii\mail\MailerInterface|array|string The mailer object or the application component ID of the mailer object. yii\log\EmailTarget
$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
$message array The configuration array for creating a message object. yii\log\EmailTarget
$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

公共方法

隐藏继承的方法

方法描述定义在
__call() 调用不是类方法的指定的方法. yii\base\Component
__clone() 在通过克隆现有对象创建对象之后调用此方法. yii\base\Component
__construct() 构造函数. yii\base\BaseObject
__get() 返回组件属性的值. yii\base\Component
__isset() 检查属性是否已设置, 即已定义且不为null. yii\base\Component
__set() 设置组件属性的值. yii\base\Component
__unset() 将组件属性设置为null. yii\base\Component
attachBehavior() 将行为附加到此组件. yii\base\Component
attachBehaviors() 将行为列表附加到组件. yii\base\Component
behaviors() 返回此组件应该具有的行为列表. yii\base\Component
canGetProperty() 返回一个值, 指示属性是否可读取. yii\base\Component
canSetProperty() 返回一个值, 指示属性是否可设置. yii\base\Component
className() 返回此类的完全限定名称. yii\base\BaseObject
collect() Processes the given log messages. yii\log\Target
detachBehavior() 从组件中分离一个行为. yii\base\Component
detachBehaviors() 分离组件中的所有行为. yii\base\Component
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件. yii\base\Component
export() Sends log messages to specified email addresses. yii\log\EmailTarget
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() 返回指定的行为对象. yii\base\Component
getBehaviors() 返回附加到此组件的所有行为. 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() 返回一个值, 指示是否有任何处理程序附加到指定的事件. yii\base\Component
hasMethod() 返回一个值, 指示方法是否已定义. yii\base\Component
hasProperty() 返回一个值, 指示属性是否已定义. yii\base\Component
init() 初始化对象. yii\log\EmailTarget
off() 从该组件分离现有的事件处理程序. yii\base\Component
on() 将事件处理程序附加到事件. 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() 触发事件. yii\base\Component

受保护的方法

隐藏继承的方法

方法描述定义在
composeMessage() Composes a mail message with the given body content. yii\log\EmailTarget
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

属性详情

$mailer public 属性

The mailer object or the application component ID of the mailer object. After the EmailTarget object is created, if you want to change this property, you should only assign it with a mailer object. Starting from version 2.0.2, this can also be a configuration array for creating the object.

$message public 属性

The configuration array for creating a message object. Note that the "to" option must be set, which specifies the destination email address(es).

public array $message = []

方法详情

composeMessage() protected 方法

Composes a mail message with the given body content.

protected yii\mail\MessageInterface composeMessage ( $body )
$body string

The body content

return yii\mail\MessageInterface

$message

export() public 方法

Sends log messages to specified email addresses.

Starting from version 2.0.14, this method throws LogRuntimeException in case the log can not be exported.

public void export ( )
throws yii\log\LogRuntimeException
init() public 方法

初始化对象.

在使用给定的配置初始化对象之后, 在构造函数的末尾调用此方法.

public void init ( )