Класс yii\mongodb\debug\ExplainAction
| Наследование | yii\mongodb\debug\ExplainAction » yii\base\Action » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0.5 |
| Исходный код | https://github.com/yiisoft/yii2-mongodb/blob/master/debug/ExplainAction.php |
ExplainAction предоставляет информацию EXPLAIN для запросов к MongoDB
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | Список присоединенных к этому компоненту поведений | yii\base\Component |
| $controller | yii\base\Controller|yii\web\Controller | Контроллер, которому принадлежит этот action | yii\base\Action |
| $id | string | ID action | yii\base\Action |
| $panel | yii\mongodb\debug\MongoDbPanel | Связанная панель инструментальной панели отладки | yii\mongodb\debug\ExplainAction |
| $uniqueId | string | Уникальный ID этого action во всем приложении. | yii\base\Action |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Object |
| __clone() | Этот метод вызывается после создания объекта путём клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Action |
| __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 |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту. | yii\base\Component |
| getBehavior() | Возвращает объект поведения с заданным именем. | yii\base\Component |
| getBehaviors() | Возвращает все присоединенные к этому компоненту поведения. | yii\base\Component |
| getUniqueId() | Возвращает уникальный ID этого action во всем приложении. | yii\base\Action |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчик, прикрепленный к событию с указанным именем. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\base\Object |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| run() | Выполняет действие explain | yii\mongodb\debug\ExplainAction |
| runWithParams() | Выполняет это действие с указанными параметрами. | yii\base\Action |
| trigger() | Вызывает событие. | yii\base\Component |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| afterRun() | Этот метод вызывается сразу после выполнения run(). | yii\base\Action |
| beforeRun() | Этот метод вызывается сразу перед выполнением run(). | yii\base\Action |
| explainQuery() | Выполняет команду explain над запросом | yii\mongodb\debug\ExplainAction |
Подробное описание свойств
$panel общедоступное свойство
Связанный панель отладки
public yii\mongodb\debug\MongoDbPanel $panel = null
Подробное описание методов
explainQuery() защищенный метод
Выполняет команду explain над запросом
| защищенный массив|false explainQuery ( $queryString ) | ||
|---|---|---|
| $queryString | строка |
Строка журнала запроса. |
| return | массив|false |
Результаты объяснения, |
run() общедоступный метод
Выполняет действие explain
| общедоступный строка run ( $seq, $tag ) | ||
|---|---|---|
| $seq | целое число | |
| $tag | строка | |
| return | строка |
Содержимое результата объяснения |
| throws | yii\web\HttpException |
если запрашиваемый журнал не найден |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-mongodb-debug-explainaction.html