Класс yii\debug\LogTarget
| Наследование | yii\debug\LogTarget » yii\log\Target » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступен с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-debug/blob/master/LogTarget.php |
Целевой LogTarget для отладки используется для хранения журналов для последующего использования в инструменте отладки
Общедоступные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | Список поведений, присоединённых к этому компоненту | yii\base\Component |
| $categories | array | Список категорий сообщений, в которых заинтересован этот целевой объект. | yii\log\Target |
| $enabled | boolean | Включён ли этот целевой объект журнала. | yii\log\Target |
| $except | array | Список категорий сообщений, в которых этот целевой объект НЕ заинтересован. | yii\log\Target |
| $exportInterval | integer | Сколько сообщений должно быть накоплено перед экспортом. | yii\log\Target |
| $levels | integer | Уровни сообщений, в которых заинтересован этот целевой объект. | yii\log\Target |
| $logVars | array | Список предопределённых переменных PHP, которые должны быть записаны в сообщении. | yii\log\Target |
| $messages | array | Сообщения, которые получены от логгера до сих пор этим целевым объектом журнала. | yii\log\Target |
| $module | yii\debug\Module | yii\debug\LogTarget | |
| $prefix | callable | PHP-вызов, возвращающий строку, которая должна быть префиксом каждого экспортируемого сообщения. | yii\log\Target |
| $tag | yii\debug\LogTarget |
Общедоступные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Object |
| __clone() | Этот метод вызывается после создания объекта путём клонирования существующего. | yii\base\Component |
| __construct() | yii\debug\LogTarget | |
| __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\debug\LogTarget |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту. | yii\base\Component |
| export() | Экспортирует сообщения журнала в определённый пункт назначения. | yii\debug\LogTarget |
| 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\base\Object |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| setLevels() | Устанавливает уровни сообщений, в которых заинтересован этот целевой объект. | yii\log\Target |
| trigger() | Вызывает событие. | yii\base\Component |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| collectSummary() | Сбор сводной информации текущего запроса. | yii\debug\LogTarget |
| gc() | yii\debug\LogTarget | |
| getContextMessage() | Генерирует контекстную информацию для логирования. | yii\log\Target |
| getSqlTotalCount() | Возвращает общее количество выполненных SQL-запросов в текущем запросе. Если панель базы данных не настроена, возвращает 0. | yii\debug\LogTarget |
Подробное описание свойств
$module публичное свойство
public yii\debug\Module $module = null
$tag публичное свойство
public $tag = null Подробное описание методов
__construct() публичный метод
| public void __construct ( $module, $config = [] ) | ||
|---|---|---|
| $module | yii\debug\Module | |
| $config | массив | |
collect() публичный метод
Обрабатывает предоставленные сообщения журнала.
Этот метод отфильтрует предоставленные сообщения с помощью $levels и $categories. Если необходимо, он также экспортирует результат фильтрации в определенный канал (например, почту).
| public void collect ( $messages, $final ) | ||
|---|---|---|
| $messages | массив |
Сообщения журнала для обработки. См. yii\log\Logger::$messages для структуры каждого сообщения. |
| $final | boolean |
Является ли этот метод вызываемым в конце текущего приложения |
collectSummary() защищённый метод
Сбор сводной информации текущего запроса.
| protected массив collectSummary ( ) |
|---|
export() публичный метод
Экспорт сообщений журнала в определенное место назначения.
Дочерние классы должны реализовать этот метод.
| public void export ( ) |
|---|
gc() защищённый метод
| protected void gc ( &$manifest ) | ||
|---|---|---|
| $manifest | ||
getSqlTotalCount() защищённый метод
Возвращает общее количество выполненных SQL-запросов в текущем запросе. Если панель базы данных не настроена, возвращает 0.
| protected целое число getSqlTotalCount ( ) |
|---|
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-debug-logtarget.html