Class yii\debug\panels\DbPanel

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

Debugger panel that collects and displays database 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 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\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 yii\debug\panels\DbPanel
$id string Panel unique identifier. yii\debug\Panel
$module yii\debug\Module yii\debug\Panel
$name string Name of the panel yii\debug\panels\DbPanel
$profileLogs array yii\debug\panels\DbPanel
$summary string Content that is displayed at debug toolbar yii\debug\panels\DbPanel
$summaryName string Short name of the panel, which will be use in summary. 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 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\Object
__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\debug\panels\DbPanel
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\Object
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\debug\panels\DbPanel
getError() yii\debug\Panel
getName() yii\debug\panels\DbPanel
getProfileLogs() Returns all profile logs of the current request for this panel. It includes categories such as: 'yii\db\Command::query', 'yii\db\Command::execute'. yii\debug\panels\DbPanel
getSummary() yii\debug\panels\DbPanel
getSummaryName() yii\debug\panels\DbPanel
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\debug\panels\DbPanel
isEnabled() Is the panel enabled? yii\debug\panels\DbPanel
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\panels\DbPanel
setError() yii\debug\Panel
trigger() Triggers an event. yii\base\Component

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
getModels() Returns an array of models that represents logs of the current request. yii\debug\panels\DbPanel
getQueryType() Returns database query type. yii\debug\panels\DbPanel
getTotalQueryTime() Returns total query time. yii\debug\panels\DbPanel
hasExplain() yii\debug\panels\DbPanel

Property Details

$criticalQueryThreshold public property

The threshold for determining whether the request has involved critical number of DB queries. If the number of queries exceeds this number, the execution is considered taking critical number of DB queries.

$db public read-only property

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

$defaultFilter public property (available since version 2.0.7)

The default filter to apply to the database queries. In the format of [ property => value ], for example: [ 'type' => 'SELECT' ]

public array $defaultFilter = []
$defaultOrder public property (available since version 2.0.7)

The default ordering of the database queries. In the format of [ property => sort direction ], for example: [ 'duration' => SORT_DESC ]

public array $defaultOrder = ['seq' => SORT_ASC]
$detail public read-only property

Content that is displayed in debugger detail view

public string getDetail ( )
$name public read-only property

Name of the panel

public string getName ( )
$profileLogs public read-only property
$summary public read-only property

Content that is displayed at debug toolbar

public string getSummary ( )
$summaryName public read-only property

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

$types public read-only property
public array getTypes ( )

Method Details

calculateTimings() public method

Calculates given request profile timings.

public array calculateTimings ( )
return array

Timings [token, category, timestamp, traces, nesting level, elapsed time]

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

getDb() public method (available since version 2.0.5)

Returns a reference to the DB component associated with the panel

public yii\db\Connection getDb ( )
getDetail() public method

public string getDetail ( )
return string

Content that is displayed in debugger detail view

getModels() protected method

Returns an array of models that represents logs of the current request.

Can be used with data providers such as \yii\data\ArrayDataProvider.

protected array getModels ( )
return array

Models

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. It includes categories such as: 'yii\db\Command::query', 'yii\db\Command::execute'.

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.

getSummary() public method

public string getSummary ( )
return string

Content that is displayed at debug toolbar

getSummaryName() public method

public string getSummaryName ( )
return string

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

getTotalQueryTime() protected method

Returns total query time.

protected integer getTotalQueryTime ( $timings )
$timings array
return integer

Total time

getTypes() public method (available since version 2.0.3)

Returns array query types

public array getTypes ( )
hasExplain() protected method (available since version 2.0.5)

protected boolean hasExplain ( )
return boolean

Whether the DB component has support for EXPLAIN queries

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 ( )
isEnabled() public method

Is the panel enabled?

public boolean isEnabled ( )
isQueryCountCritical() public method

Check if given queries count is critical according settings.

public boolean isQueryCountCritical ( $count )
$count integer

Queries count

save() public method

Saves data to be later used in debugger detail view.

This method is called on every page where debugger is enabled.

public mixed save ( )
return mixed

Data to be saved