Spec-Zone.ru › Yii 2.0

Класс yii\log\EmailTarget

Все классы | Свойства | Методы
Наследование yii\log\EmailTarget » yii\log\Target » yii\base\Component » yii\base\Object
Реализует yii\base\Configurable
Доступно с версии 2.0
Исходный код https://github.com/yiisoft/yii2/blob/master/framework/log/EmailTarget.php

EmailTarget отправляет выбранные сообщения журнала указанным адресам электронной почты.

Вы можете настроить отправку почты, задав свойство $message, через которое вы можете установить целевые адреса электронной почты, тему и т. д.:

'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',
                 ],
             ],
         ],
    ],
],

В приведённом выше примере mailer - это идентификатор компонента, отправляющего электронную почту, и он должен быть уже настроен.

Публичные свойства

Свойство Тип Описание Определено
$behaviors yii\base\Behavior[] Список поведений, прикреплённых к этому компоненту yii\base\Component
$categories массив Список категорий сообщений, в которых заинтересован этот целевой объект. yii\log\Target
$enabled boolean Включить ли этот целевой объект журнала. yii\log\Target
$except массив Список категорий сообщений, в которых этот целевой объект НЕ заинтересован. yii\log\Target
$exportInterval целое число Сколько сообщений должно быть накоплено перед их экспортом. yii\log\Target
$levels целое число Уровни сообщений, в которых заинтересован этот целевой объект. yii\log\Target
$logVars массив Список предопределённых переменных PHP, которые должны быть включены в сообщение. yii\log\Target
$mailer yii\mail\MailerInterface|массив|строка Объект отправителя почты или идентификатор компонента приложения объекта отправителя почты. yii\log\EmailTarget
$message массив Массив конфигурации для создания объекта сообщения message. yii\log\EmailTarget
$messages массив Сообщения, полученные из логгера до сих пор этим целевым объектом журнала. yii\log\Target
$prefix callable Вызываемый фрагмент PHP, который возвращает строку, которая будет добавляться как префикс к каждому экспортируемому сообщению. yii\log\Target

Публичные методы

Метод Описание Определено в
__call() Вызывает именованный метод, который не является методом класса. yii\base\Object
__clone() Этот метод вызывается после создания объекта путём клонирования существующего. yii\base\Component
__construct() Конструктор. yii\base\Object
__get() Возвращает значение свойства объекта. yii\base\Object
__isset() Проверяет, установлено ли свойство, т.е. определено и не равно null. yii\base\Object
__set() Устанавливает значение свойства объекта. yii\base\Object
__unset() Устанавливает свойство объекта в значение null. yii\base\Object
attachBehavior() Присоединяет поведение к этому компоненту. yii\base\Component
attachBehaviors() Присоединяет список поведений к компоненту. yii\base\Component
behaviors() Возвращает список поведений, которые должен использовать этот компонент. yii\base\Component
canGetProperty() Возвращает значение, указывающее, можно ли прочитать свойство. yii\base\Object
canSetProperty() Возвращает значение, указывающее, можно ли установить свойство. yii\base\Object
className() Возвращает полное квалифицированное имя этого класса. yii\base\Object
collect() Обрабатывает заданные сообщения журнала. yii\log\Target
detachBehavior() Отсоединяет поведение от компонента. yii\base\Component
detachBehaviors() Отсоединяет все поведения от компонента. yii\base\Component
ensureBehaviors() Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту. yii\base\Component
export() Отправляет сообщения журнала на указанные адреса электронной почты. yii\log\EmailTarget
filterMessages() Фильтрует заданные сообщения в соответствии с их категориями и уровнями. yii\log\Target
formatMessage() Форматирует сообщение журнала для отображения в виде строки. yii\log\Target
getBehavior() Возвращает объект именованного поведения. yii\base\Component
getBehaviors() Возвращает все поведения, присоединённые к этому компоненту. yii\base\Component
getLevels() yii\log\Target
getMessagePrefix() Возвращает строку, которая будет добавлена в начало заданного сообщения. yii\log\Target
hasEventHandlers() Возвращает значение, указывающее, есть ли обработчик, присоединённый к именованному событию. yii\base\Component
hasMethod() Возвращает значение, указывающее, определён ли метод. yii\base\Object
hasProperty() Возвращает значение, указывающее, определено ли свойство. yii\base\Object
init() Инициализирует объект. yii\log\EmailTarget
off() Отсоединяет существующий обработчик событий от этого компонента. yii\base\Component
on() Присоединяет обработчик событий к событию. yii\base\Component
setLevels() Устанавливает уровни сообщений, которые интересуют этот целевой элемент. yii\log\Target
trigger() Срабатывает событие. yii\base\Component

Защищенные методы

Метод Описание Определено в
composeMessage() Создаёт сообщение электронной почты с заданным содержимым тела. yii\log\EmailTarget
getContextMessage() Генерирует контекстную информацию для регистрации. yii\log\Target

Подробное описание свойств

$mailer общедоступное свойство

Объект mailer или идентификатор компонента приложения объекта mailer. После создания объекта EmailTarget, если вы хотите изменить это свойство, вы должны присвоить ему только объект mailer. Начиная с версии 2.0.2, это также может быть массив конфигурации для создания объекта.

public yii\mail\MailerInterface|array|string $mailer = 'mailer'

$message общедоступное свойство

Массив конфигурации для создания объекта сообщения. Обратите внимание, что параметр "to" должен быть установлен, который указывает адрес(ы) электронной почты получателя.

public array $message = []

Подробное описание методов

composeMessage() защищённый метод

Создаёт сообщение электронной почты с заданным содержимым тела.

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

Содержимое тела

return yii\mail\MessageInterface

$message

export() общедоступный метод

Отправляет сообщения журнала на указанные адреса электронной почты.

public void export ( )

init() общедоступный метод

Инициализирует объект.

Этот метод вызывается в конце конструктора после инициализации объекта заданной конфигурацией.

public void init ( )

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API