Класс yii\debug\panels\DbPanel
| Наследование | yii\debug\panels\DbPanel » yii\debug\Panel » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Подклассы | yii\mongodb\debug\MongoDbPanel |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-debug/blob/master/panels/DbPanel.php |
Панель отладчика, которая собирает и отображает запросы к базе данных.
Открытые свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $actions | массив | Массив действий, которые нужно добавить к контроллеру по умолчанию модуля отладки. | yii\debug\Panel |
| $behaviors | yii\base\Behavior[] | Список присоединенных к этому компоненту поведений. | yii\base\Component |
| $criticalQueryThreshold | целое число | Порог для определения, содержал ли запрос критического количества запросов к базе данных. | yii\debug\panels\DbPanel |
| $data | смешанный тип | Данные, связанные с панелью. | yii\debug\Panel |
| $db | строка | Имя компонента базы данных, который нужно использовать для выполнения (объяснения) запросов. | yii\debug\panels\DbPanel |
| $defaultFilter | массив | Фильтр по умолчанию, который необходимо применить к запросам к базе данных. | yii\debug\panels\DbPanel |
| $defaultOrder | массив | По умолчанию порядок запросов к базе данных. | yii\debug\panels\DbPanel |
| $detail | строка | Содержимое, отображаемое в детальном представлении отладчика. | yii\debug\panels\DbPanel |
| $id | строка | Уникальный идентификатор панели. | yii\debug\Panel |
| $module | yii\debug\Module | yii\debug\Panel | |
| $name | строка | Имя панели. | yii\debug\panels\DbPanel |
| $profileLogs | массив | yii\debug\panels\DbPanel | |
| $summary | строка | Содержимое, отображаемое на панели отладки. | yii\debug\panels\DbPanel |
| $summaryName | строка | Короткое имя панели, которое будет использовано в сводке. | yii\debug\panels\DbPanel |
| $tag | строка | Идентификатор набора данных запроса. | yii\debug\Panel |
| $types | массив | yii\debug\panels\DbPanel | |
| $url | строка | URL, указывающий на детальное представление панели. | yii\debug\Panel |
Открытые методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Component |
| __clone() | Этот метод вызывается после создания объекта путём клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства компонента. | yii\base\Component |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Component |
| __set() | Устанавливает значение свойства компонента. | yii\base\Component |
| __unset() | Устанавливает свойство компонента в значение null. | yii\base\Component |
| attachBehavior() | Прикрепляет поведение к компоненту. | yii\base\Component |
| attachBehaviors() | Прикрепляет список поведений к компоненту. | yii\base\Component |
| behaviors() | Возвращает список поведений, по которым должен вести себя этот компонент. | yii\base\Component |
| calculateTimings() | Вычисляет заданные временные отметки профиля запроса. | yii\debug\panels\DbPanel |
| canBeExplained() | Проверяет, можно ли объяснить данный тип запроса. | yii\debug\panels\DbPanel |
| canGetProperty() | Возвращает значение, указывающее, можно ли прочитать свойство. | yii\base\Component |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Component |
| className() | Возвращает полное имя этого класса. | yii\base\Object |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), прикреплены к этому компоненту. | yii\base\Component |
| getBehavior() | Возвращает объект именованного поведения. | yii\base\Component |
| getBehaviors() | Возвращает все поведения, прикрепленные к этому компоненту. | yii\base\Component |
| getDb() | Возвращает ссылку на компонент DB, связанный с панелью. | yii\debug\panels\DbPanel |
| getDetail() | yii\debug\panels\DbPanel | |
| getName() | yii\debug\panels\DbPanel | |
| getProfileLogs() | Возвращает все журналы профиля текущего запроса для этой панели. Он включает категории, такие как: 'yii\db\Command::query', 'yii\db\Command::execute'. | yii\debug\panels\DbPanel |
| getSummary() | yii\debug\panels\DbPanel | |
| getSummaryName() | yii\debug\panels\DbPanel | |
| getTraceLine() | Возвращает строку трассировки. | yii\debug\Panel |
| getTypes() | Возвращает массив типов запросов. | yii\debug\panels\DbPanel |
| getUrl() | yii\debug\Panel | |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчик, прикрепленный к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определен ли метод. | yii\base\Component |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство для этого компонента. | yii\base\Component |
| init() | Инициализирует объект. | yii\debug\panels\DbPanel |
| isQueryCountCritical() | Проверяет, является ли заданное количество запросов критическим в соответствии с настройками. | yii\debug\panels\DbPanel |
| load() | Загружает данные в панель. | yii\debug\Panel |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Прикрепляет обработчик событий к событию. | yii\base\Component |
| save() | Сохраняет данные для последующего использования в детальном представлении отладчика. | yii\debug\panels\DbPanel |
| trigger() | Вызывает событие. | yii\base\Component |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| getModels() | Возвращает массив моделей, представляющих логи текущего запроса. | yii\debug\panels\DbPanel |
| getQueryType() | Возвращает тип запроса базы данных. | yii\debug\panels\DbPanel |
| getTotalQueryTime() | Возвращает общее время запроса. | yii\debug\panels\DbPanel |
| hasExplain() | yii\debug\panels\DbPanel |
Подробное описание свойств
$criticalQueryThreshold общедоступное свойство
Порог, определяющий, включал ли запрос критическое количество запросов к базе данных. Если количество запросов превышает это число, выполнение считается критическим по количеству запросов к базе данных.
public integer $criticalQueryThreshold = null
$db общедоступное свойство только для чтения
Имя компонента базы данных, используемого для выполнения (объяснения) запросов.
public yii\db\Connection getDb ( )
$defaultFilter общедоступное свойство (доступно с версии 2.0.7)
Фильтры по умолчанию, применяемые к запросам к базе данных. В формате [ свойство => значение ], например: [ 'type' => 'SELECT' ]
public array $defaultFilter = []
$defaultOrder общедоступное свойство (доступно с версии 2.0.7)
Упорядочение запросов к базе данных по умолчанию. В формате [ свойство => порядок сортировки ], например: [ 'duration' => SORT_DESC ]
public array $defaultOrder = ['seq' => SORT_ASC]
$detail общедоступное свойство только для чтения
Содержание, отображаемое в детальном представлении отладчика.
public string getDetail ( )
$name общедоступное свойство только для чтения
Название панели.
public string getName ( )
$profileLogs общедоступное свойство только для чтения
public array getProfileLogs ( )
$summary общедоступное свойство только для чтения
Контент, отображаемый в панели отладки
public string getSummary ( )
$summaryName открытое только для чтения свойство
Короткое имя панели, которое будет использоваться в сводке.
public string getSummaryName ( )
$types открытое только для чтения свойство
public array getTypes ( )
Подробное описание методов
calculateTimings() открытый метод
Вычисляет временные характеристики заданного профиля запроса.
| открытый массив calculateTimings ( ) | ||
|---|---|---|
| возвращаемое значение | массив |
Временные характеристики [токен, категория, метка времени, трассы, уровень вложенности, затраченное время] |
canBeExplained() открытый статический метод (доступен начиная с версии 2.0.5)
Проверяет, можно ли объяснить заданный тип запроса.
| открытый статический логический canBeExplained ( $type ) | ||
|---|---|---|
| $type | строка |
Тип запроса |
getDb() открытый метод (доступен начиная с версии 2.0.5)
Возвращает ссылку на компонент базы данных, связанный с панелью
| открытый yii\db\Connection getDb ( ) |
|---|
getDetail() открытый метод
| открытый строка getDetail ( ) | ||
|---|---|---|
| возвращаемое значение | строка |
Контент, отображаемый в детальном представлении отладчика |
getModels() защищенный метод
Возвращает массив моделей, представляющих логи текущего запроса.
Может использоваться с поставщиками данных, такими как \yii\data\ArrayDataProvider.
| защищенный массив getModels ( ) | ||
|---|---|---|
| возвращаемое значение | массив |
Модели |
getName() открытый метод
| открытый строка getName ( ) | ||
|---|---|---|
| возвращаемое значение | строка |
Имя панели |
getProfileLogs() открытый метод
Возвращает все логи профилирования текущего запроса для этой панели. Он включает категории, такие как: 'yii\db\Command::query', 'yii\db\Command::execute'.
| открытый массив getProfileLogs ( ) |
|---|
getQueryType() защищенный метод
Возвращает тип запроса к базе данных.
| защищенный строка getQueryType ( $timing ) | ||
|---|---|---|
| $timing | строка |
Строка процедуры измерения времени |
| возвращаемое значение | строка |
Тип запроса, такой как select, insert, delete и т. д. |
getSummary() открытый метод
| открытый строка getSummary ( ) | ||
|---|---|---|
| возвращаемое значение | строка |
Контент, отображаемый в панели отладки |
getSummaryName() открытый метод
| открытый строка getSummaryName ( ) | ||
|---|---|---|
| возвращаемое значение | строка |
Короткое имя панели, которое будет использоваться в сводке. |
getTotalQueryTime() защищенный метод
Возвращает общее время выполнения запроса.
| защищенный целое число getTotalQueryTime ( $timings ) | ||
|---|---|---|
| $timings | массив | |
| возвращаемое значение | целое число |
Общее время |
getTypes() открытый метод (доступен начиная с версии 2.0.3)
Возвращает массив типов запросов
| открытый массив getTypes ( ) |
|---|
hasExplain() защищенный метод (доступен начиная с версии 2.0.5)
| защищенный логический hasExplain ( ) | ||
|---|---|---|
| возвращаемое значение | логический |
Поддерживает ли компонент базы данных запросы EXPLAIN |
init() открытый метод
Инициализирует объект.
Этот метод вызывается в конце конструктора после инициализации объекта заданной конфигурацией.
| открытый void init ( ) |
|---|
isQueryCountCritical() открытый метод
Проверяет, является ли заданное количество запросов критическим в соответствии с настройками.
| открытый логический isQueryCountCritical ( $count ) | ||
|---|---|---|
| $count | целое число |
Количество запросов |
save() открытый метод
Сохраняет данные для последующего использования в детальном представлении отладчика.
Этот метод вызывается на каждой странице, где включена отладка.
| открытый mixed save ( ) | ||
|---|---|---|
| возвращаемое значение | mixed |
Сохраняемые данные |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-debug-panels-dbpanel.html
