Класс yii\log\Dispatcher
| Наследование | yii\log\Dispatcher » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/log/Dispatcher.php |
Dispatcher управляет набором мишеней лога.
Dispatcher реализует метод dispatch(), который пересылает сообщения лога из yii\log\Logger зарегистрированным мишеням лога $targets.
Экземпляр Dispatcher зарегистрирован в качестве основного компонента приложения и может быть получен с помощью Yii::$app->log.
Вы можете настроить мишени в конфигурации приложения, например, следующим образом:
[
'components' => [
'log' => [
'targets' => [
'file' => [
'class' => 'yii\log\FileTarget',
'levels' => ['trace', 'info'],
'categories' => ['yii\*'],
],
'email' => [
'class' => 'yii\log\EmailTarget',
'levels' => ['error', 'warning'],
'message' => [
'to' => 'admin@example.com',
],
],
],
],
],
]
Каждая мишень лога может иметь имя и может быть обращена по имени через свойство $targets следующим образом:
Yii::$app->log->targets['file']->enabled = false;
Открытые свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | Список поведений, прикрепленных к этому компоненту | yii\base\Component |
| $flushInterval | integer | Сколько сообщений должно быть записано в лог, прежде чем они будут отправлены мишеням. | yii\log\Dispatcher |
| $logger | yii\log\Logger | Журнализатор. | yii\log\Dispatcher |
| $targets | массив|yii\log\Target[] | Мишени лога. | yii\log\Dispatcher |
| $traceLevel | integer | Сколько стеков вызовов приложения должно быть записано вместе с каждым сообщением. | yii\log\Dispatcher |
Открытые методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Object |
| __clone() | Этот метод вызывается после создания объекта путем клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\log\Dispatcher |
| __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 |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| dispatch() | Пересылает записанные сообщения в $targets. | yii\log\Dispatcher |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), прикреплены к этому компоненту. | yii\base\Component |
| getBehavior() | Возвращает объект поведения с указанным именем. | yii\base\Component |
| getBehaviors() | Возвращает все присоединенные к этому компоненту поведения. | yii\base\Component |
| getFlushInterval() | yii\log\Dispatcher | |
| getLogger() | Получает подключенный журнализатор. | yii\log\Dispatcher |
| getTraceLevel() | yii\log\Dispatcher | |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли какой-либо обработчик, прикрепленный к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определен ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\log\Dispatcher |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Прикрепляет обработчик событий к событию. | yii\base\Component |
| setFlushInterval() | yii\log\Dispatcher | |
| setLogger() | Устанавливает подключенный журнализатор. | yii\log\Dispatcher |
| setTraceLevel() | yii\log\Dispatcher | |
| trigger() | Вызывает событие. | yii\base\Component |
Подробное описание свойств
$flushInterval открытое свойство
Сколько сообщений должно быть записано в лог, прежде чем они будут отправлены мишеням. Этот метод возвращает значение yii\log\Logger::$flushInterval.
public integer getFlushInterval ( )
public void setFlushInterval ( $value )
$logger открытое свойство
Журнализатор.
public yii\log\Logger getLogger ( )
public void setLogger ( $value )
$targets открытое свойство
Мишени лога. Каждый элемент массива представляет собой экземпляр отдельной мишени лога или конфигурацию для создания экземпляра мишени лога.
public array|yii\log\Target[] $targets = []
$traceLevel открытое свойство
Сколько стеков вызовов приложения должно быть записано вместе с каждым сообщением. Этот метод возвращает значение yii\log\Logger::$traceLevel. По умолчанию 0.
public integer getTraceLevel ( )
public void setTraceLevel ( $value )
Подробное описание методов
__construct() public method
Конструктор.
Реализация по умолчанию выполняет два действия:
- Инициализирует объект заданной конфигурацией
$config. - Вызывает init().
Если этот метод переопределён в дочернем классе, рекомендуется
- сделать последний параметр конструктора массивом конфигурации, как в примере
$config. - вызвать родительскую реализацию в конце конструктора.
| public void __construct ( $config = [] ) | ||
|---|---|---|
| $config | массив |
Пара имя-значение, которые будут использованы для инициализации свойств объекта |
dispatch() public method
Пересылает зарегистрированные сообщения в $targets.
| public void dispatch ( $messages, $final ) | ||
|---|---|---|
| $messages | массив |
Зарегистрированные сообщения |
| $final | булево |
Является ли этот метод вызываемым в конце текущего приложения |
getFlushInterval() public method
| public целое число getFlushInterval ( ) | ||
|---|---|---|
| return | целое число |
Сколько сообщений должно быть зарегистрировано, прежде чем они будут отправлены в целевые пункты назначения. Этот метод возвращает значение yii\log\Logger::$flushInterval. |
getLogger() public method
Получает подключенный логгер.
Если не задано, будет использоваться Yii::getLogger().
| public yii\log\Logger getLogger ( ) | ||
|---|---|---|
| return | yii\log\Logger |
Логгер. |
getTraceLevel() public method
| public целое число getTraceLevel ( ) | ||
|---|---|---|
| return | целое число |
Сколько стеков вызовов приложения должно быть зарегистрировано вместе с каждым сообщением. Этот метод возвращает значение yii\log\Logger::$traceLevel. По умолчанию 0. |
init() public method
Инициализирует объект.
Этот метод вызывается в конце конструктора после инициализации объекта заданной конфигурацией.
| public void init ( ) |
|---|
setFlushInterval() public method
| public void setFlushInterval ( $value ) | ||
|---|---|---|
| $value | целое число |
Сколько сообщений должно быть зарегистрировано, прежде чем они будут отправлены в целевые пункты назначения. Этот метод задаёт значение yii\log\Logger::$flushInterval. По умолчанию 1000, что означает, что метод yii\log\Logger::flush() будет вызываться каждые 1000 зарегистрированных сообщений. Установите это свойство в 0, если вы не хотите сбрасывать сообщения до завершения приложения. Это свойство главным образом влияет на то, сколько памяти будет занимать зарегистрированные сообщения. Более низкое значение означает меньшую потребляемую память, но увеличивает время выполнения из-за накладных расходов yii\log\Logger::flush(). |
setLogger() public method
Устанавливает подключённый логгер.
| public void setLogger ( $value ) | ||
|---|---|---|
| $value | yii\log\Logger|строка|массив |
Используемый логгер. Это может быть экземпляр логгера или конфигурация, которая будет использоваться для создания его с помощью Yii::createObject(). |
setTraceLevel() public method
| public void setTraceLevel ( $value ) | ||
|---|---|---|
| $value | целое число |
Сколько стеков вызовов приложения должно быть зарегистрировано вместе с каждым сообщением. Этот метод установит значение yii\log\Logger::$traceLevel. Если значение больше 0, будет зарегистрировано не более этого количества стеков вызовов. Обратите внимание, что учитываются только стеки вызовов приложения. По умолчанию 0. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-log-dispatcher.html