Class yii\mongodb\debug\MongoDbPanel

Inheritanceyii\mongodb\debug\MongoDbPanel » yii\debug\panels\DbPanel » yii\debug\Panel » yii\base\Component » yii\base\BaseObject
Implementsyii\base\Configurable
Available since version2.0.1
Source Code https://github.com/yiisoft/yii2-mongodb/blob/master/debug/MongoDbPanel.php

MongoDbPanel panel that collects and displays MongoDB queries performed.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$actions array Array of actions to add to the debug modules default controller. yii\debug\Panel
$behaviors yii\base\Behavior[] List of behaviors attached to this component. This property is read-only. yii\base\Component
$criticalQueryThreshold integer The threshold for determining whether the request has involved critical number of DB queries. yii\debug\panels\DbPanel
$data mixed Data associated with panel yii\debug\Panel
$db string The name of the database component to use for executing (explain) queries yii\mongodb\debug\MongoDbPanel
$dbEventNames array Of event names used to get profile logs. yii\debug\panels\DbPanel
$defaultFilter array The default filter to apply to the database queries. yii\debug\panels\DbPanel
$defaultOrder array The default ordering of the database queries. yii\debug\panels\DbPanel
$detail string Content that is displayed in debugger detail view. This property is read-only. yii\debug\Panel
$id string Panel unique identifier. yii\debug\Panel
$module yii\debug\Module yii\debug\Panel
$name string Name of the panel. This property is read-only. yii\debug\Panel
$profileLogs array This property is read-only. yii\debug\panels\DbPanel
$summary string Content that is displayed at debug toolbar. This property is read-only. yii\debug\Panel
$summaryName string Short name of the panel, which will be use in summary. This property is read-only. yii\debug\panels\DbPanel
$tag string Request data set identifier. yii\debug\Panel
$types array yii\debug\panels\DbPanel
$url string URL pointing to panel detail view. This property is read-only. yii\debug\Panel

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$error yii\debug\FlattenException|null Error while saving the panel yii\debug\Panel

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\Component
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of a component property. yii\base\Component
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Component
__set() Sets the value of a component property. yii\base\Component
__unset() Sets a component property to be null. yii\base\Component
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
calculateTimings() Calculates given request profile timings. yii\debug\panels\DbPanel
canBeExplained() Check if given query type can be explained. yii\mongodb\debug\MongoDbPanel
canGetProperty() Returns a value indicating whether a property can be read. yii\base\Component
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Component
className() Returns the fully qualified name of this class. yii\base\BaseObject
countDuplicateQuery() Return associative array, where key is query string and value is number of occurrences the same query in array. yii\debug\panels\DbPanel
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
getDb() Returns a reference to the DB component associated with the panel yii\debug\panels\DbPanel
getDetail() yii\mongodb\debug\MongoDbPanel
getError() yii\debug\Panel
getName() yii\mongodb\debug\MongoDbPanel
getProfileLogs() Returns all profile logs of the current request for this panel. yii\mongodb\debug\MongoDbPanel
getSummary() yii\debug\Panel
getSummaryName() yii\mongodb\debug\MongoDbPanel
getTraceLine() Returns a trace line yii\debug\Panel
getTypes() Returns array query types yii\debug\panels\DbPanel
getUrl() yii\debug\Panel
hasError() yii\debug\Panel
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event. yii\base\Component
hasMethod() Returns a value indicating whether a method is defined. yii\base\Component
hasProperty() Returns a value indicating whether a property is defined for this component. yii\base\Component
init() Initializes the object. yii\mongodb\debug\MongoDbPanel
isEnabled() Checks whether this panel is enabled. yii\debug\Panel
isQueryCountCritical() Check if given queries count is critical according settings. yii\debug\panels\DbPanel
load() Loads data into the panel yii\debug\Panel
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
save() Saves data to be later used in debugger detail view. yii\debug\Panel
setError() yii\debug\Panel
sumDuplicateQueries() Returns sum of all duplicated queries yii\debug\panels\DbPanel
trigger() Triggers an event. yii\base\Component

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
getLogMessages() Gets messages from log target and filters according to their categories and levels. yii\debug\Panel
getModels() Returns an array of models that represents logs of the current request. yii\debug\panels\DbPanel
getQueryType() Returns database query type. yii\mongodb\debug\MongoDbPanel
getTotalQueryTime() Returns total query time. yii\debug\panels\DbPanel
hasExplain() yii\mongodb\debug\MongoDbPanel

Property Details

$db public property

The name of the database component to use for executing (explain) queries

public string $db 'mongodb'

Method Details

canBeExplained() public static method (available since version 2.0.5)

Check if given query type can be explained.

public static boolean canBeExplained ( $type )
$type string

Query type

getDetail() public method

public string getDetail ( )
return string

Content that is displayed in debugger detail view

throws yii\base\InvalidConfigException
getName() public method

public string getName ( )
return string

Name of the panel

getProfileLogs() public method

Returns all profile logs of the current request for this panel.

public array getProfileLogs ( )
getQueryType() protected method

Returns database query type.

protected string getQueryType ( $timing )
$timing string

Timing procedure string

return string

Query type such as select, insert, delete, etc.

getSummaryName() public method

public string getSummaryName ( )
return string

Short name of the panel, which will be use in summary.

hasExplain() protected method (available since version 2.0.5)

protected boolean hasExplain ( )
return boolean

Whether the DB component has support for EXPLAIN queries

throws yii\base\InvalidConfigException
init() public method

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )