Класс yii\log\DbTarget
| Наследование | yii\log\DbTarget » yii\log\Target » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/log/DbTarget.php |
DbTarget сохраняет сообщения журнала в таблице базы данных.
Подключение к базе данных задается свойством $db. Схема базы данных может быть инициализирована с помощью миграции:
yii migrate --migrationPath=@yii/log/migrations/
Если вы не хотите использовать миграцию и вам нужен SQL, файлы для всех баз данных находятся в директории миграций.
Вы можете изменить имя таблицы, используемой для хранения данных, задав свойство $logTable.
Общедоступные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | Список присоединенных к этому компоненту поведений | yii\base\Component |
| $categories | массив | Список категорий сообщений, которые интересуют этот целевой объект. | yii\log\Target |
| $db | yii\db\Connection|массив|строка | Объект подключения к БД или идентификатор компонента приложения для подключения к БД. | yii\log\DbTarget |
| $enabled | булево | Включить ли этот целевой объект журнала. | yii\log\Target |
| $except | массив | Список категорий сообщений, которые этого целевого объекта не интересуют. | yii\log\Target |
| $exportInterval | целое число | Сколько сообщений следует накапливать перед их экспортом. | yii\log\Target |
| $levels | целое число | Уровни сообщений, которые интересуют этот целевой объект. | yii\log\Target |
| $logTable | строка | Имя таблицы БД для хранения кэшированных данных. | yii\log\DbTarget |
| $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() | Сохраняет сообщения журнала в БД. | yii\log\DbTarget |
| 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() | Инициализирует компонент DbTarget. | yii\log\DbTarget |
| off() | Отсоединяет существующего обработчика событий от данного компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| setLevels() | Устанавливает уровни сообщений, которые интересуют этот целевой объект. | yii\log\Target |
| trigger() | Вызывает событие. | yii\base\Component |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| getContextMessage() | Генерирует контекстную информацию для записи в журнал. | yii\log\Target |
Подробное описание свойств
$db общедоступное свойство
Объект подключения к БД или идентификатор приложения компонента подключения к БД. После создания объекта DbTarget, если вы хотите изменить это свойство, вам следует присвоить ему только объект подключения к БД. Начиная с версии 2.0.2, это также может быть массив конфигурации для создания объекта.
public yii\db\Connection|array|string $db = 'db'
$logTable общедоступное свойство
Имя таблицы БД для хранения содержимого кэша. По умолчанию равно "log".
public string $logTable = '{{%log}}'
Подробное описание методов
export() общедоступный метод
Сохраняет сообщения журнала в БД.
| public void export ( ) |
|---|
init() общедоступный метод
Инициализирует компонент DbTarget.
Этот метод инициализирует свойство $db, чтобы убедиться, что оно ссылается на действительное подключение к БД.
| 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-log-dbtarget.html
