Класс yii\mongodb\log\MongoDbTarget
| Наследование | yii\mongodb\log\MongoDbTarget » yii\log\Target » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-mongodb/blob/master/log/MongoDbTarget.php |
MongoDbTarget сохраняет сообщения логов в коллекции MongoDB.
По умолчанию MongoDbTarget сохраняет сообщения логов в коллекции MongoDB с именем 'log'. Коллекцию можно изменить, установив свойство $logCollection.
Общедоступные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | Список поведений, прикрепленных к этому компоненту | yii\base\Component |
| $categories | массив | Список категорий сообщений, которые интересуют этот целевой объект. | yii\log\Target |
| $db | yii\mongodb\Connection|строка | Объект подключения к MongoDB или идентификатор приложения компонента MongoDB-подключения. | yii\mongodb\log\MongoDbTarget |
| $enabled | логическое значение | Включить ли этот целевой объект логов. | yii\log\Target |
| $except | массив | Список категорий сообщений, которые НЕ интересуют этот целевой объект. | yii\log\Target |
| $exportInterval | целое число | Сколько сообщений должно быть накоплено перед их экспортом. | yii\log\Target |
| $levels | целое число | Уровни сообщений, которые интересуют этот целевой объект. | yii\log\Target |
| $logCollection | строка|массив | Имя коллекции MongoDB, которая хранит данные сессии. | yii\mongodb\log\MongoDbTarget |
| $logVars | массив | Список предопределённых PHP переменных, которые должны быть записаны в сообщении. | yii\log\Target |
| $messages | массив | Сообщения, полученные от логгера до сих пор этим целевым объектом логов. | yii\log\Target |
| $prefix | обратный вызов | Обратный вызов 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() | Сохраняет сообщения журнала в коллекцию MongoDB. | yii\mongodb\log\MongoDbTarget |
| 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() | Инициализирует компонент MongoDbTarget. | yii\mongodb\log\MongoDbTarget |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| setLevels() | Устанавливает уровни сообщений, которые интересуют этот целевой обработчик. | yii\log\Target |
| trigger() | Вызывает событие. | yii\base\Component |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| getContextMessage() | Генерирует контекстную информацию для регистрации. | yii\log\Target |
Подробности свойств
$db общедоступное свойство
Объект подключения к MongoDB или идентификатор компонента приложения для подключения к MongoDB. После создания объекта MongoDbTarget, если вы хотите изменить это свойство, вы должны назначить ему только объект подключения к MongoDB.
public yii\mongodb\Connection|string $db = 'mongodb'
$logCollection общедоступное свойство
Имя коллекции MongoDB, которая хранит данные сеанса. Обратитесь к yii\mongodb\Connection::getCollection() для указания этого параметра. Эту коллекцию лучше предварительно создать с полями 'id' и 'expire', индексированными.
public string|array $logCollection = 'log'
Подробности методов
export() общедоступный метод
Сохраняет сообщения журнала в коллекцию MongoDB.
| public void export ( ) |
|---|
init() общедоступный метод
Инициализирует компонент MongoDbTarget.
Этот метод инициализирует свойство $db, чтобы убедиться, что оно ссылается на действительное подключение к MongoDB.
| public void init ( ) | ||
|---|---|---|
| throws | yii\base\InvalidConfigException |
если $db недействителен. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-mongodb-log-mongodbtarget.html
