Class yii\mongodb\debug\ExplainAction

All Classes | Properties | Methods
Inheritanceyii\mongodb\debug\ExplainAction » yii\base\Action
Available since version2.0.5

ExplainAction provides EXPLAIN information for MongoDB queries

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$panel yii\mongodb\debug\MongoDbPanel Related debug toolbar panel yii\mongodb\debug\ExplainAction

Public Methods

Hide inherited methods

MethodDescriptionDefined By
run() Runs the explain action yii\mongodb\debug\ExplainAction

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
getCursorFromQueryLog() Create MongoCursor from string query log yii\mongodb\debug\ExplainAction
prepareQuery() Prepare query for using in MongoCursor. yii\mongodb\debug\ExplainAction

Property Details

$panel public property

Related debug toolbar panel

public yii\mongodb\debug\MongoDbPanel $panel = null

Method Details

getCursorFromQueryLog() protected method

Create MongoCursor from string query log

protected \MongoCursor|null getCursorFromQueryLog ( $queryString )
$queryString string
prepareQuery() protected method

Prepare query for using in MongoCursor.

Converts array contains $id key into \yii\mongodb\debug\MongoId instance. If array given, each element of it will be processed.

protected array|string prepareQuery ( $query )
$query mixed

Raw query
return array|string

Prepared query
run() public method

Runs the explain action

public string run ( $seq, $tag )
$seq integer
$tag string
return string

Explain result content
throws \yii\web\HttpException

if requested log not found