# Class yii\debug\panels\DbPanel

Inheritance | yii\debug\panels\DbPanel » yii\debug\Panel » yii\base\Component » yii\base\BaseObject
Implements | yii\base\Configurable
Subclasses | yii\mongodb\debug\MongoDbPanel
Available since version | 2.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

Property | Type | Description | Defined 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|null | 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
$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. | yii\debug\Panel
$error | yii\debug\FlattenException|null | Error while saving the panel | yii\debug\Panel
$excessiveCallerThreshold | integer|null | The number of DB calls the same backtrace can make before considered an "Excessive Caller". | yii\debug\panels\DbPanel
$excessiveCallers | array | The number of DB calls indexed by the backtrace hash of excessive caller(s). | yii\debug\panels\DbPanel
$excessiveCallersCount | integer |  | yii\debug\panels\DbPanel
$id | string | Panel unique identifier. | yii\debug\Panel
$ignoredPathsInBacktrace | string[] | The files and/or paths defined here will be ignored in the determination of DB "Callers". | yii\debug\panels\DbPanel
$module | yii\debug\Module |  | yii\debug\Panel
$name | string | Name of the panel. | yii\debug\Panel
$profileLogs | array |  | yii\debug\panels\DbPanel
$summary | string | Content that is displayed at debug toolbar. | yii\debug\Panel
$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

Property | Type | Description | Defined By
--- | --- | --- | ---

## Public Methods

Hide inherited methods

Method | Description | Defined 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\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\BaseObject
countCallerCals() | Counts the number of times the same backtrace makes a DB query. | yii\debug\panels\DbPanel
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
generateQueryCallersDataProvider() | Creates an ArrayDataProvider for the DB query callers. | yii\debug\panels\DbPanel
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
getExcessiveCallers() | Get the backtrace hashes that make excessive DB cals. | yii\debug\panels\DbPanel
getExcessiveCallersCount() | Get the number of excessive caller(s). | yii\debug\panels\DbPanel
getName() |  | yii\debug\panels\DbPanel
getProfileLogs() | Returns all profile logs of the current request for this panel. It includes categories specified in $this->dbEventNames property. | 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() | Checks whether this panel is enabled. | yii\debug\panels\DbPanel
isNumberOfCallsExcessive() | Check if the number of calls by "Caller" is excessive according to the settings. | yii\debug\panels\DbPanel
isQueryCountCritical() | Check if given queries count is critical according to the 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
sumDuplicateQueries() | Returns sum of all duplicated queries | yii\debug\panels\DbPanel
trigger() | Triggers an event. | yii\base\Component

## Protected Methods

Hide inherited methods

Method | Description | Defined 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\debug\panels\DbPanel
getTotalQueryTime() | Returns total query time. | yii\debug\panels\DbPanel
hasExplain() |  | yii\debug\panels\DbPanel

## Property Details

Hide inherited properties

$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. If it is `null`, this feature is disabled.

public integer|null $criticalQueryThreshold = null
$db public property

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

public string $db = 'db'
$dbEventNames public property (available since version 2.1.17)

Of event names used to get profile logs.

public array $dbEventNames = [
'yii\db\Command::query',
'yii\db\Command::execute',
]
$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,
]
$excessiveCallerThreshold public property (available since version 2.1.23)

The number of DB calls the same backtrace can make before considered an "Excessive Caller". If it is `null`, this feature is disabled. Note: Changes will only be reflected in new requests.

public integer|null $excessiveCallerThreshold = null
$excessiveCallers public property

The number of DB calls indexed by the backtrace hash of excessive caller(s).

public array $excessiveCallers = null
$excessiveCallersCount public read-only property (available since version 2.1.23)
public integer getExcessiveCallersCount ( )
$ignoredPathsInBacktrace public property (available since version 2.1.23)

The files and/or paths defined here will be ignored in the determination of DB "Callers". The "Caller" is the backtrace lines that aren't included in the `$ignoredPathsInBacktrace`, Yii files are ignored by default. Hint: You can use path aliases here.

public string[] $ignoredPathsInBacktrace = []
$profileLogs public property
public array $profileLogs = null
$summaryName public property

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

public string $summaryName = null
$types public read-only property (available since version 2.0.3)
public array getTypes ( )

## Method Details

Hide inherited methods

__call() public method

Defined in: yii\base\Component::__call()

Calls the named method which is not a class method.

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

public mixed __call ( $name, $params )
$name | string | The method name
$params | array | Method parameters
return | mixed | The method return value
throws | yii\base\UnknownMethodException | when calling unknown method

Source code

                    public function __call($name, $params)
    {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $object) {
            if ($object->hasMethod($name)) {
                return call_user_func_array([$object, $name], $params);
            }
        }
        throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
    }

__clone() public method

Defined in: yii\base\Component::__clone()

This method is called after the object is created by cloning an existing one.

It removes all behaviors because they are attached to the old object.

public void __clone ( )

Source code

                    public function __clone()
    {
        $this->_events = [];
        $this->_eventWildcards = [];
        $this->_behaviors = null;
    }

__construct() public method

Defined in: yii\base\BaseObject::__construct()

Constructor.

The default implementation does two things:

- Initializes the object with the given configuration `$config`.
- Call init().

If this method is overridden in a child class, it is recommended that

- the last parameter of the constructor is a configuration array, like `$config` here.
- call the parent implementation at the end of the constructor.

public void __construct ( $config = [] )
$config | array | Name-value pairs that will be used to initialize the object properties

Source code

                    public function __construct($config = [])
    {
        if (!empty($config)) {
            Yii::configure($this, $config);
        }
        $this->init();
    }

__get() public method

Defined in: yii\base\Component::__get()

Returns the value of a component property.

This method will check in the following order and act accordingly:

- a property defined by a getter: return the getter result
- a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing `$value = $component->property;`.

See also __set().

public mixed __get ( $name )
$name | string | The property name
return | mixed | The property value or the value of a behavior's property
throws | yii\base\UnknownPropertyException | if the property is not defined
throws | yii\base\InvalidCallException | if the property is write-only.

Source code

                    public function __get($name)
    {
        $getter = 'get' . $name;
        if (method_exists($this, $getter)) {
            // read property, e.g. getName()
            return $this->$getter();
        }
        // behavior property
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name)) {
                return $behavior->$name;
            }
        }
        if (method_exists($this, 'set' . $name)) {
            throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
        }
        throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
    }

__isset() public method

Defined in: yii\base\Component::__isset()

Checks if a property is set, i.e. defined and not null.

This method will check in the following order and act accordingly:

- a property defined by a setter: return whether the property is set
- a property of a behavior: return whether the property is set
- return `false` for non existing properties

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing `isset($component->property)`.

See also https://www.php.net/manual/en/function.isset.php.

public boolean __isset ( $name )
$name | string | The property name or the event name
return | boolean | Whether the named property is set

Source code

                    public function __isset($name)
    {
        $getter = 'get' . $name;
        if (method_exists($this, $getter)) {
            return $this->$getter() !== null;
        }
        // behavior property
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name)) {
                return $behavior->$name !== null;
            }
        }
        return false;
    }

__set() public method

Defined in: yii\base\Component::__set()

Sets the value of a component property.

This method will check in the following order and act accordingly:

- a property defined by a setter: set the property value
- an event in the format of "on xyz": attach the handler to the event "xyz"
- a behavior in the format of "as xyz": attach the behavior named as "xyz"
- a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing `$component->property = $value;`.

See also __get().

public void __set ( $name, $value )
$name | string | The property name or the event name
$value | mixed | The property value
throws | yii\base\UnknownPropertyException | if the property is not defined
throws | yii\base\InvalidCallException | if the property is read-only.

Source code

                    public function __set($name, $value)
    {
        $setter = 'set' . $name;
        if (method_exists($this, $setter)) {
            // set property
            $this->$setter($value);
            return;
        } elseif (strncmp($name, 'on ', 3) === 0) {
            // on event: attach event handler
            $this->on(trim(substr($name, 3)), $value);
            return;
        } elseif (strncmp($name, 'as ', 3) === 0) {
            // as behavior: attach behavior
            $name = trim(substr($name, 3));
            $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
            return;
        }
        // behavior property
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name)) {
                $behavior->$name = $value;
                return;
            }
        }
        if (method_exists($this, 'get' . $name)) {
            throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
        }
        throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
    }

__unset() public method

Defined in: yii\base\Component::__unset()

Sets a component property to be null.

This method will check in the following order and act accordingly:

- a property defined by a setter: set the property value to be null
- a property of a behavior: set the property value to be null

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing `unset($component->property)`.

See also https://www.php.net/manual/en/function.unset.php.

public void __unset ( $name )
$name | string | The property name
throws | yii\base\InvalidCallException | if the property is read only.

Source code

                    public function __unset($name)
    {
        $setter = 'set' . $name;
        if (method_exists($this, $setter)) {
            $this->$setter(null);
            return;
        }
        // behavior property
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name)) {
                $behavior->$name = null;
                return;
            }
        }
        throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
    }

attachBehavior() public method

Defined in: yii\base\Component::attachBehavior()

Attaches a behavior to this component.

This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the yii\base\Behavior::attach() method.

See also detachBehavior().

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name | string | The name of the behavior.

$behavior

string|array|yii\base\Behavior

The behavior configuration. This can be one of the following:

- a yii\base\Behavior object
- a string specifying the behavior class
- an object configuration array that will be passed to Yii::createObject() to create the behavior object.

return | yii\base\Behavior | The behavior object

Source code

                    public function attachBehavior($name, $behavior)
    {
        $this->ensureBehaviors();
        return $this->attachBehaviorInternal($name, $behavior);
    }

attachBehaviors() public method

Defined in: yii\base\Component::attachBehaviors()

Attaches a list of behaviors to the component.

Each behavior is indexed by its name and should be a yii\base\Behavior object, a string specifying the behavior class, or an configuration array for creating the behavior.

See also attachBehavior().

public void attachBehaviors ( $behaviors )
$behaviors | array | List of behaviors to be attached to the component

Source code

                    public function attachBehaviors($behaviors)
    {
        $this->ensureBehaviors();
        foreach ($behaviors as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }

behaviors() public method

Defined in: yii\base\Component::behaviors()

Returns a list of behaviors that this component should behave as.

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

    'behaviorName' => [
        'class' => 'BehaviorClass',
        'property1' => 'value1',
        'property2' => 'value2',
    ]

Note that a behavior class must extend from yii\base\Behavior. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using getBehavior() or be detached using detachBehavior(). Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

public array behaviors ( )
return | array | The behavior configurations.

Source code

                    public function behaviors()
    {
        return [];
    }

calculateTimings() public method

Calculates given request profile timings.

public array calculateTimings ( )
return | array | Timings [token, category, timestamp, traces, nesting level, elapsed time]

Source code

                    public function calculateTimings()
    {
        if ($this->_timings === null) {
            $this->_timings = Yii::getLogger()->calculateTimings(isset($this->data['messages']) ? $this->data['messages'] : $this->getProfileLogs());
            // Parse aliases
            $ignoredPathsInBacktrace = array_map(
                function($path) {
                    return Yii::getAlias($path);
                },
                $this->ignoredPathsInBacktrace
            );
            // Generate hash for caller
            $hashAlgo = in_array('xxh3', hash_algos()) ? 'xxh3' : 'crc32';
            foreach ($this->_timings as &$timing) {
                if ($ignoredPathsInBacktrace) {
                    foreach ($timing['trace'] as $index => $trace) {
                        foreach ($ignoredPathsInBacktrace as $ignoredPathInBacktrace) {
                            if (isset($trace['file']) && strpos($trace['file'], $ignoredPathInBacktrace) === 0) {
                                unset($timing['trace'][$index]);
                            }
                        }
                    }
                }
                $timing['traceHash'] = hash($hashAlgo, json_encode($timing['trace']));
            }
        }
        return $this->_timings;
    }

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

Source code

                    public static function canBeExplained($type)
    {
        return $type !== 'SHOW';
    }

canGetProperty() public method

Defined in: yii\base\Component::canGetProperty()

Returns a value indicating whether a property can be read.

A property can be read if:

- the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when `$checkVars` is true);
- an attached behavior has a readable property of the given name (when `$checkBehaviors` is true).

See also canSetProperty().

public boolean canGetProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name | string | The property name
$checkVars | boolean | Whether to treat member variables as properties
$checkBehaviors | boolean | Whether to treat behaviors' properties as properties of this component
return | boolean | Whether the property can be read

Source code

                    public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
    {
        if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
            return true;
        } elseif ($checkBehaviors) {
            $this->ensureBehaviors();
            foreach ($this->_behaviors as $behavior) {
                if ($behavior->canGetProperty($name, $checkVars)) {
                    return true;
                }
            }
        }
        return false;
    }

canSetProperty() public method

Defined in: yii\base\Component::canSetProperty()

Returns a value indicating whether a property can be set.

A property can be written if:

- the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when `$checkVars` is true);
- an attached behavior has a writable property of the given name (when `$checkBehaviors` is true).

See also canGetProperty().

public boolean canSetProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name | string | The property name
$checkVars | boolean | Whether to treat member variables as properties
$checkBehaviors | boolean | Whether to treat behaviors' properties as properties of this component
return | boolean | Whether the property can be written

Source code

                    public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
    {
        if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
            return true;
        } elseif ($checkBehaviors) {
            $this->ensureBehaviors();
            foreach ($this->_behaviors as $behavior) {
                if ($behavior->canSetProperty($name, $checkVars)) {
                    return true;
                }
            }
        }
        return false;
    }

className() public static method
Deprecated since 2.0.14. On PHP >=5.5, use `::class` instead.

Defined in: yii\base\BaseObject::className()

Returns the fully qualified name of this class.

public static string className ( )
return | string | The fully qualified name of this class.

Source code

                    public static function className()
    {
        return get_called_class();
    }

countCallerCals() public method (available since version 2.1.23)

Counts the number of times the same backtrace makes a DB query.

public array countCallerCals ( )
return | array | The number of DB calls indexed by the backtrace hash of the caller.

Source code

                    public function countCallerCals()
    {
        $query = ArrayHelper::getColumn($this->calculateTimings(), 'traceHash');
        return array_count_values($query);
    }

countDuplicateQuery() public method (available since version 2.0.13)

Return associative array, where key is query string and value is number of occurrences the same query in array.

public array countDuplicateQuery ( $timings )
$timings |  |

Source code

                    public function countDuplicateQuery($timings)
    {
        $query = ArrayHelper::getColumn($timings, 'info');
        return array_count_values($query);
    }

detachBehavior() public method

Defined in: yii\base\Component::detachBehavior()

Detaches a behavior from the component.

The behavior's yii\base\Behavior::detach() method will be invoked.

public yii\base\Behavior|null detachBehavior ( $name )
$name | string | The behavior's name.
return | yii\base\Behavior|null | The detached behavior. Null if the behavior does not exist.

Source code

                    public function detachBehavior($name)
    {
        $this->ensureBehaviors();
        if (isset($this->_behaviors[$name])) {
            $behavior = $this->_behaviors[$name];
            unset($this->_behaviors[$name]);
            $behavior->detach();
            return $behavior;
        }
        return null;
    }

detachBehaviors() public method

Defined in: yii\base\Component::detachBehaviors()

Detaches all behaviors from the component.

public void detachBehaviors ( )

Source code

                    public function detachBehaviors()
    {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $name => $behavior) {
            $this->detachBehavior($name);
        }
    }

ensureBehaviors() public method

Defined in: yii\base\Component::ensureBehaviors()

Makes sure that the behaviors declared in behaviors() are attached to this component.

public void ensureBehaviors ( )

Source code

                    public function ensureBehaviors()
    {
        if ($this->_behaviors === null) {
            $this->_behaviors = [];
            foreach ($this->behaviors() as $name => $behavior) {
                $this->attachBehaviorInternal($name, $behavior);
            }
        }
    }

generateQueryCallersDataProvider() public method (available since version 2.1.23)

Creates an ArrayDataProvider for the DB query callers.

public yii\data\ArrayDataProvider generateQueryCallersDataProvider ( $modelData )
$modelData | array |

Source code

                    public function generateQueryCallersDataProvider($modelData)
    {
        $callers = [];
        foreach ($modelData as $data) {
            if (!array_key_exists($data['traceHash'], $callers)) {
                $callers[$data['traceHash']] = [
                    'trace' => $data['trace'],
                    'numCalls' => 0,
                    'totalDuration' => 0,
                    'queries' => []
                ];
            }
            $callers[$data['traceHash']]['numCalls'] += 1;
            $callers[$data['traceHash']]['totalDuration'] += $data['duration'];
            $callers[$data['traceHash']]['queries'][] = [
                'timestamp' => $data['timestamp'],
                'duration' => $data['duration'],
                'query' => $data['query'],
                'type' => $data['type'],
                'seq' => $data['seq'],
            ];
        }
        return new ArrayDataProvider([
            'allModels' => $callers,
            'pagination' => false,
            'sort' => [
                'attributes' => ['numCalls', 'totalDuration'],
                'defaultOrder' => ['numCalls' => SORT_DESC],
            ],
        ]);
    }

getBehavior() public method

Defined in: yii\base\Component::getBehavior()

Returns the named behavior object.

public yii\base\Behavior|null getBehavior ( $name )
$name | string | The behavior name
return | yii\base\Behavior|null | The behavior object, or null if the behavior does not exist

Source code

                    public function getBehavior($name)
    {
        $this->ensureBehaviors();
        return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
    }

getBehaviors() public method

Defined in: yii\base\Component::getBehaviors()

Returns all behaviors attached to this component.

public yii\base\Behavior[] getBehaviors ( )
return | yii\base\Behavior[] | List of behaviors attached to this component

Source code

                    public function getBehaviors()
    {
        $this->ensureBehaviors();
        return $this->_behaviors;
    }

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 ( )
throws | yii\base\InvalidConfigException |

Source code

                    public function getDb()
    {
        return Yii::$app->get($this->db);
    }

getDetail() public method

public string getDetail ( )
return | string | Content that is displayed in debugger detail view
throws | yii\base\InvalidConfigException |

Source code

                    public function getDetail()
    {
        $searchModel = new Db();
        if (!$searchModel->load(Yii::$app->request->getQueryParams())) {
            $searchModel->load($this->defaultFilter, '');
        }
        $models = $this->getModels();
        $queryDataProvider = $searchModel->search($models);
        $queryDataProvider->getSort()->defaultOrder = $this->defaultOrder;
        $sumDuplicates = $this->sumDuplicateQueries($models);
        $callerDataProvider = $this->generateQueryCallersDataProvider($models);
        return Yii::$app->view->render('panels/db/detail', [
            'panel' => $this,
            'queryDataProvider' => $queryDataProvider,
            'callerDataProvider' => $callerDataProvider,
            'searchModel' => $searchModel,
            'hasExplain' => $this->hasExplain(),
            'sumDuplicates' => $sumDuplicates,
        ]);
    }

getError() public method (available since version 2.0.10)

Defined in: yii\debug\Panel::getError()

public yii\debug\FlattenException|null getError ( )

Source code

                    public function getError()
    {
        return $this->error;
    }

getExcessiveCallers() public method (available since version 2.1.23)

Get the backtrace hashes that make excessive DB cals.

public array getExcessiveCallers ( )
return | array | The number of DB calls indexed by the backtrace hash of excessive caller(s).

Source code

                    public function getExcessiveCallers()
    {
        if ($this->excessiveCallerThreshold === null) {
            return [];
        }
        return array_filter(
            $this->countCallerCals(),
            function ($count) {
                return $count >= $this->excessiveCallerThreshold;
            }
        );
    }

getExcessiveCallersCount() public method (available since version 2.1.23)

Get the number of excessive caller(s).

public integer getExcessiveCallersCount ( )

Source code

                    public function getExcessiveCallersCount()
    {
        return count($this->getExcessiveCallers());
    }

getLogMessages() protected method (available since version 2.1.4)

Defined in: yii\debug\Panel::getLogMessages()

Gets messages from log target and filters according to their categories and levels.

See also yii\log\Target::filterMessages().

protected array getLogMessages ( $levels = 0, $categories = [], $except = [], $stringify = false )
$levels | integer | The message levels to filter by. This is a bitmap of level values. Value 0 means allowing all levels.
$categories | array | The message categories to filter by. If empty, it means all categories are allowed.
$except | array | The message categories to exclude. If empty, it means all categories are allowed.
$stringify | boolean | Convert non-string (such as closures) to strings
return | array | The filtered messages.

Source code

                    protected function getLogMessages($levels = 0, $categories = [], $except = [], $stringify = false)
    {
        $target = $this->module->logTarget;
        $messages = $target->filterMessages($target->messages, $levels, $categories, $except);
        if (!$stringify) {
            return $messages;
        }
        foreach ($messages as &$message) {
            if (!isset($message[0]) || is_string($message[0])) {
                continue;
            }
            // exceptions may not be serializable if in the call stack somewhere is a Closure
            if ($message[0] instanceof \Throwable || $message[0] instanceof \Exception) {
                $message[0] = (string) $message[0];
            } else {
                $message[0] = VarDumper::export($message[0]);
            }
        }
        return $messages;
    }

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

Source code

                    protected function getModels()
    {
        if ($this->_models === null) {
            $this->_models = [];
            $timings = $this->calculateTimings();
            $duplicates = $this->countDuplicateQuery($timings);
            foreach ($timings as $seq => $dbTiming) {
                $this->_models[] = [
                    'type' => $this->getQueryType($dbTiming['info']),
                    'query' => $dbTiming['info'],
                    'duration' => ($dbTiming['duration'] * 1000), // in milliseconds
                    'trace' => $dbTiming['trace'],
                    'traceHash' => $dbTiming['traceHash'],
                    'timestamp' => ($dbTiming['timestamp'] * 1000), // in milliseconds
                    'seq' => $seq,
                    'duplicate' => $duplicates[$dbTiming['info']],
                ];
            }
        }
        return $this->_models;
    }

getName() public method

public string getName ( )
return | string | Name of the panel

Source code

                    public function getName()
    {
        return 'Database';
    }

getProfileLogs() public method

Returns all profile logs of the current request for this panel. It includes categories specified in $this->dbEventNames property.

public array getProfileLogs ( )

Source code

                    public function getProfileLogs()
    {
        if ($this->_profileLogs === null) {
            $this->_profileLogs = $this->getLogMessages(Logger::LEVEL_PROFILE, $this->dbEventNames);
        }
        return $this->_profileLogs;
    }

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.

Source code

                    protected function getQueryType($timing)
    {
        $timing = ltrim($timing);
        preg_match('/^([a-zA-z]*)/', $timing, $matches);
        return count($matches) ? mb_strtoupper($matches[0], 'utf8') : '';
    }

getSummary() public method

public string getSummary ( )
return | string | Content that is displayed at debug toolbar

Source code

                    public function getSummary()
    {
        $timings = $this->calculateTimings();
        $queryCount = count($timings);
        $queryTime = number_format($this->getTotalQueryTime($timings) * 1000) . ' ms';
        $excessiveCallerCount = $this->getExcessiveCallersCount();
        return Yii::$app->view->render('panels/db/summary', [
            'timings' => $this->calculateTimings(),
            'panel' => $this,
            'queryCount' => $queryCount,
            'queryTime' => $queryTime,
            'excessiveCallerCount' => $excessiveCallerCount,
        ]);
    }

getSummaryName() public method

public string getSummaryName ( )
return | string | Short name of the panel, which will be use in summary.

Source code

                    public function getSummaryName()
    {
        return 'DB';
    }

getTotalQueryTime() protected method

Returns total query time.

protected integer getTotalQueryTime ( $timings )
$timings | array |
return | integer | Total time

Source code

                    protected function getTotalQueryTime($timings)
    {
        $queryTime = 0;
        foreach ($timings as $timing) {
            $queryTime += $timing['duration'];
        }
        return $queryTime;
    }

getTraceLine() public method (available since version 2.0.7)

Defined in: yii\debug\Panel::getTraceLine()

Returns a trace line

public string getTraceLine ( $options )
$options | array | The array with trace
return | string | The trace line

Source code

                    public function getTraceLine($options)
    {
        /**
         * If an internal PHP function, such as `call_user_func`, in the backtrace, the 'file' and 'line' not be available.
         * @see https://www.php.net/manual/en/function.debug-backtrace.php#59713
         */
        if (!isset($options['file'])) {
            return VarDumper::dumpAsString($options);
        }
        if (!isset($options['text'])) {
            $options['text'] = "{$options['file']}:{$options['line']}";
        }
        $traceLine = $this->module->traceLine;
        if ($traceLine === false) {
            return $options['text'];
        }
        $options['file'] = str_replace('\\', '/', $options['file']);
        foreach ($this->module->tracePathMappings as $old => $new) {
            $old = rtrim(str_replace('\\', '/', $old), '/') . '/';
            if (StringHelper::startsWith($options['file'], $old)) {
                $new = rtrim(str_replace('\\', '/', $new), '/') . '/';
                $options['file'] = $new . substr($options['file'], strlen($old));
                break;
            }
        }
        $rawLink = $traceLine instanceof \Closure ? $traceLine($options, $this) : $traceLine;
        return strtr($rawLink, ['{file}' => $options['file'], '{line}' => $options['line'], '{text}' => $options['text']]);
    }

getTypes() public method (available since version 2.0.3)

Returns array query types

public array getTypes ( )

Source code

                    public function getTypes()
    {
        return array_reduce(
            $this->_models,
            function ($result, $item) {
                $result[$item['type']] = $item['type'];
                return $result;
            },
            []
        );
    }

getUrl() public method

Defined in: yii\debug\Panel::getUrl()

public string getUrl ( $additionalParams = null )
$additionalParams | null|array | Optional additional parameters to add to the route
return | string | URL pointing to panel detail view

Source code

                    public function getUrl($additionalParams = null)
    {
        $route = [
            '/' . $this->module->getUniqueId() . '/default/view',
            'panel' => $this->id,
            'tag' => $this->tag,
        ];
        if (is_array($additionalParams)) {
            $route = ArrayHelper::merge($route, $additionalParams);
        }
        return Url::toRoute($route);
    }

hasError() public method (available since version 2.0.10)

Defined in: yii\debug\Panel::hasError()

public boolean hasError ( )

Source code

                    public function hasError()
    {
        return $this->error !== null;
    }

hasEventHandlers() public method

Defined in: yii\base\Component::hasEventHandlers()

Returns a value indicating whether there is any handler attached to the named event.

public boolean hasEventHandlers ( $name )
$name | string | The event name
return | boolean | Whether there is any handler attached to the event.

Source code

                    public function hasEventHandlers($name)
    {
        $this->ensureBehaviors();
        if (!empty($this->_events[$name])) {
            return true;
        }
        foreach ($this->_eventWildcards as $wildcard => $handlers) {
            if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
                return true;
            }
        }
        return Event::hasHandlers($this, $name);
    }

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 |

Source code

                    protected function hasExplain()
    {
        $db = $this->getDb();
        if (!($db instanceof \yii\db\Connection)) {
            return false;
        }
        switch ($db->getDriverName()) {
            case 'mysql':
            case 'sqlite':
            case 'pgsql':
            case 'cubrid':
                return true;
            default:
                return false;
        }
    }

hasMethod() public method

Defined in: yii\base\Component::hasMethod()

Returns a value indicating whether a method is defined.

A method is defined if:

- the class has a method with the specified name
- an attached behavior has a method with the given name (when `$checkBehaviors` is true).

public boolean hasMethod ( $name, $checkBehaviors = true )
$name | string | The property name
$checkBehaviors | boolean | Whether to treat behaviors' methods as methods of this component
return | boolean | Whether the method is defined

Source code

                    public function hasMethod($name, $checkBehaviors = true)
    {
        if (method_exists($this, $name)) {
            return true;
        } elseif ($checkBehaviors) {
            $this->ensureBehaviors();
            foreach ($this->_behaviors as $behavior) {
                if ($behavior->hasMethod($name)) {
                    return true;
                }
            }
        }
        return false;
    }

hasProperty() public method

Defined in: yii\base\Component::hasProperty()

Returns a value indicating whether a property is defined for this component.

A property is defined if:

- the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when `$checkVars` is true);
- an attached behavior has a property of the given name (when `$checkBehaviors` is true).

See also:

- canGetProperty()
- canSetProperty()

public boolean hasProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name | string | The property name
$checkVars | boolean | Whether to treat member variables as properties
$checkBehaviors | boolean | Whether to treat behaviors' properties as properties of this component
return | boolean | Whether the property is defined

Source code

                    public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
    {
        return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
    }

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 ( )

Source code

                    public function init()
    {
        $this->actions['db-explain'] = [
            'class' => 'yii\\debug\\actions\\db\\ExplainAction',
            'panel' => $this,
        ];
    }

isEnabled() public method (available since version 2.0.10)

Checks whether this panel is enabled.

public boolean isEnabled ( )
return | boolean | Whether this panel is enabled.

Source code

                    public function isEnabled()
    {
        try {
            $this->getDb();
        } catch (InvalidConfigException $exception) {
            return false;
        }
        return parent::isEnabled();
    }

isNumberOfCallsExcessive() public method

Check if the number of calls by "Caller" is excessive according to the settings.

public boolean isNumberOfCallsExcessive ( $numCalls )
$numCalls | integer | Queries count

Source code

                    public function isNumberOfCallsExcessive($numCalls)
    {
        return (($this->excessiveCallerThreshold !== null) && ($numCalls > $this->excessiveCallerThreshold));
    }

isQueryCountCritical() public method

Check if given queries count is critical according to the settings.

public boolean isQueryCountCritical ( $count )
$count | integer | Queries count

Source code

                    public function isQueryCountCritical($count)
    {
        return (($this->criticalQueryThreshold !== null) && ($count > $this->criticalQueryThreshold));
    }

load() public method

Defined in: yii\debug\Panel::load()

Loads data into the panel

public void load ( $data )
$data | mixed |

Source code

                    public function load($data)
    {
        $this->data = $data;
    }

off() public method

Defined in: yii\base\Component::off()

Detaches an existing event handler from this component.

This method is the opposite of on().

Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.

See also on().

public boolean off ( $name, $handler = null )
$name | string | Event name
$handler | callable|null | The event handler to be removed. If it is null, all handlers attached to the named event will be removed.
return | boolean | If a handler is found and detached

Source code

                    public function off($name, $handler = null)
    {
        $this->ensureBehaviors();
        if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
            return false;
        }
        if ($handler === null) {
            unset($this->_events[$name], $this->_eventWildcards[$name]);
            return true;
        }
        $removed = false;
        // plain event names
        if (isset($this->_events[$name])) {
            foreach ($this->_events[$name] as $i => $event) {
                if ($event[0] === $handler) {
                    unset($this->_events[$name][$i]);
                    $removed = true;
                }
            }
            if ($removed) {
                $this->_events[$name] = array_values($this->_events[$name]);
                return true;
            }
        }
        // wildcard event names
        if (isset($this->_eventWildcards[$name])) {
            foreach ($this->_eventWildcards[$name] as $i => $event) {
                if ($event[0] === $handler) {
                    unset($this->_eventWildcards[$name][$i]);
                    $removed = true;
                }
            }
            if ($removed) {
                $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
                // remove empty wildcards to save future redundant regex checks:
                if (empty($this->_eventWildcards[$name])) {
                    unset($this->_eventWildcards[$name]);
                }
            }
        }
        return $removed;
    }

on() public method

Defined in: yii\base\Component::on()

Attaches an event handler to an event.

The event handler must be a valid PHP callback. The following are some examples:

    function ($event) { ... }         // anonymous function
    [$object, 'handleClick']          // $object->handleClick()
    ['Page', 'handleClick']           // Page::handleClick()
    'handleClick'                     // global function handleClick()

The event handler must be defined with the following signature,

    function ($event)

where `$event` is an yii\base\Event object which includes parameters associated with the event.

Since 2.0.14 you can specify event name as a wildcard pattern:

    $component->on('event.group.*', function ($event) {
        Yii::trace($event->name . ' is triggered.');
    });

See also off().

public void on ( $name, $handler, $data = null, $append = true )
$name | string | The event name
$handler | callable | The event handler
$data | mixed | The data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via yii\base\Event::$data.
$append | boolean | Whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list.

Source code

                    public function on($name, $handler, $data = null, $append = true)
    {
        $this->ensureBehaviors();
        if (strpos($name, '*') !== false) {
            if ($append || empty($this->_eventWildcards[$name])) {
                $this->_eventWildcards[$name][] = [$handler, $data];
            } else {
                array_unshift($this->_eventWildcards[$name], [$handler, $data]);
            }
            return;
        }
        if ($append || empty($this->_events[$name])) {
            $this->_events[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_events[$name], [$handler, $data]);
        }
    }

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

Source code

                    public function save()
    {
        return ['messages' => $this->getProfileLogs()];
    }

setError() public method (available since version 2.0.10)

Defined in: yii\debug\Panel::setError()

public void setError ( yii\debug\FlattenException $error )
$error | yii\debug\FlattenException |

Source code

                    public function setError(FlattenException $error)
    {
        $this->error = $error;
    }

sumDuplicateQueries() public method (available since version 2.0.13)

Returns sum of all duplicated queries

public integer sumDuplicateQueries ( $modelData )
$modelData |  |

Source code

                    public function sumDuplicateQueries($modelData)
    {
        $numDuplicates = 0;
        foreach ($modelData as $data) {
            if ($data['duplicate'] > 1) {
                $numDuplicates++;
            }
        }
        return $numDuplicates;
    }

trigger() public method

Defined in: yii\base\Component::trigger()

Triggers an event.

This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.

public void trigger ( $name, yii\base\Event $event = null )
$name | string | The event name
$event | yii\base\Event|null | The event instance. If not set, a default yii\base\Event object will be created.

Source code

                    public function trigger($name, Event $event = null)
    {
        $this->ensureBehaviors();
        $eventHandlers = [];
        foreach ($this->_eventWildcards as $wildcard => $handlers) {
            if (StringHelper::matchWildcard($wildcard, $name)) {
                $eventHandlers[] = $handlers;
            }
        }
        if (!empty($this->_events[$name])) {
            $eventHandlers[] = $this->_events[$name];
        }
        if (!empty($eventHandlers)) {
            $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
            if ($event === null) {
                $event = new Event();
            }
            if ($event->sender === null) {
                $event->sender = $this;
            }
            $event->handled = false;
            $event->name = $name;
            foreach ($eventHandlers as $handler) {
                $event->data = $handler[1];
                call_user_func($handler[0], $event);
                // stop further handling if the event is handled
                if ($event->handled) {
                    return;
                }
            }
        }
        // invoke class-level attached handlers
        Event::trigger($this, $name, $event);
    }