HumHub Documentation (unofficial)

DbPanel extends Panel
in package

Application

Debugger panel that collects and displays database queries performed.

Properties

$actions : array<string|int, mixed>
$behaviors : array<string|int, Behavior>
$criticalQueryThreshold : int|null
$data : mixed
$db : string
$dbEventNames : array<string|int, mixed>
$defaultFilter : array<string|int, mixed>
$defaultOrder : array<string|int, mixed>
$detail : string
$excessiveCallers : array<string|int, mixed>
$excessiveCallerThreshold : int|null
$id : string
$ignoredPathsInBacktrace : array<string|int, string>
$module : Module
$name : string
$profileLogs : array<string|int, mixed>
$summary : string
$summaryName : string
$tag : string
$url : string
$error : FlattenException|null
$_behaviors : array<string|int, Behavior>|null
$_events : array<string|int, mixed>
$_eventWildcards : array<string|int, mixed>
$_models : array<string|int, mixed>
$_profileLogs : array<string|int, mixed>
$_timings : array<string|int, mixed>

Methods

__call() : mixed: Calls the named method which is not a class method.
__clone() : mixed: This method is called after the object is created by cloning an existing one.
__construct() : mixed: Constructor.
__get() : mixed: Returns the value of a component property.
__isset() : bool: Checks if a property is set, i.e. defined and not null.
__set() : mixed: Sets the value of a component property.
__unset() : mixed: Sets a component property to be null.
attachBehavior() : Behavior: Attaches a behavior to this component.
attachBehaviors() : mixed: Attaches a list of behaviors to the component.
behaviors() : array<string|int, mixed>: Returns a list of behaviors that this component should behave as.
calculateTimings() : array<string|int, mixed>: Calculates given request profile timings.
canBeExplained() : bool: Check if given query type can be explained.
canGetProperty() : bool: Returns a value indicating whether a property can be read.
canSetProperty() : bool: Returns a value indicating whether a property can be set.
className() : string: Returns the fully qualified name of this class.
countCallerCals() : array<string|int, mixed>: Counts the number of times the same backtrace makes a DB query.
countDuplicateQuery() : array<string|int, mixed>: Return associative array, where key is query string and value is number of occurrences the same query in array.
detachBehavior() : Behavior|null: Detaches a behavior from the component.
detachBehaviors() : mixed: Detaches all behaviors from the component.
ensureBehaviors() : mixed: Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.
generateQueryCallersDataProvider() : ArrayDataProvider: Creates an ArrayDataProvider for the DB query callers.
getBehavior() : Behavior|null: Returns the named behavior object.
getBehaviors() : array<string|int, Behavior>: Returns all behaviors attached to this component.
getDb() : Connection: Returns a reference to the DB component associated with the panel
getDetail() : string
getError() : FlattenException|null
getExcessiveCallers() : array<string|int, mixed>: Get the backtrace hashes that make excessive DB cals.
getExcessiveCallersCount() : int: Get the number of excessive caller(s).
getName() : string
getProfileLogs() : array<string|int, mixed>: Returns all profile logs of the current request for this panel. It includes categories specified in $this->dbEventNames property.
getSummary() : string
getSummaryName() : string
getTraceLine() : string: Returns a trace line
getTypes() : array<string|int, mixed>: Returns array query types
getUrl() : string
hasError() : bool
hasEventHandlers() : bool: Returns a value indicating whether there is any handler attached to the named event.
hasMethod() : bool: Returns a value indicating whether a method is defined.
hasProperty() : bool: Returns a value indicating whether a property is defined for this component.
init() : mixed: Initializes the object.
isEnabled() : bool: Checks whether this panel is enabled.
isNumberOfCallsExcessive() : bool: Check if the number of calls by "Caller" is excessive according to the settings.
isQueryCountCritical() : bool: Check if given queries count is critical according to the settings.
load() : mixed: Loads data into the panel
off() : bool: Detaches an existing event handler from this component.
on() : mixed: Attaches an event handler to an event.
save() : mixed: Saves data to be later used in debugger detail view.
setError() : mixed
sumDuplicateQueries() : int: Returns sum of all duplicated queries
trigger() : mixed: Triggers an event.
getLogMessages() : array<string|int, mixed>: Gets messages from log target and filters according to their categories and levels.
getModels() : array<string|int, mixed>: Returns an array of models that represents logs of the current request.
getQueryType() : string: Returns database query type.
getTotalQueryTime() : int: Returns total query time.
hasExplain() : bool
attachBehaviorInternal() : Behavior: Attaches a behavior to this component.

$actions


    public
        array<string|int, mixed>
    $actions
     = []

array of actions to add to the debug modules default controller. This array will be merged with all other panels actions property. See [[\yii\base\Controller::actions()]] for the format.

$behaviors read-only


    public
        array<string|int, Behavior>
    $behaviors

List of behaviors attached to this component.

$criticalQueryThreshold


    public
        int|null
    $criticalQueryThreshold

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.

$data


    public
        mixed
    $data

data associated with panel

$db


    public
        string
    $db
     = 'db'

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

$dbEventNames


    public
        array<string|int, mixed>
    $dbEventNames
     = ['yii\db\Command::query', 'yii\db\Command::execute']

of event names used to get profile logs.

$defaultFilter


    public
        array<string|int, mixed>
    $defaultFilter
     = []

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

$defaultOrder


    public
        array<string|int, mixed>
    $defaultOrder
     = ['seq' => SORT_ASC]

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

$detail read-only


    public
        string
    $detail

Content that is displayed in debugger detail view.

$excessiveCallers read-only


    public
        array<string|int, mixed>
    $excessiveCallers

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

$excessiveCallerThreshold


    public
        int|null
    $excessiveCallerThreshold
     = null

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.

$id


    public
        string
    $id

panel unique identifier. It is set automatically by the container module.

$ignoredPathsInBacktrace


    public
        array<string|int, string>
    $ignoredPathsInBacktrace
     = []

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.

$module


    public
        Module
    $module

$name read-only


    public
        string
    $name

Name of the panel.

$profileLogs read-only


    public
        array<string|int, mixed>
    $profileLogs

$summary read-only


    public
        string
    $summary

Content that is displayed at debug toolbar.

$summaryName read-only


    public
        string
    $summaryName

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

$tag


    public
        string
    $tag

request data set identifier.

$url read-only


    public
        string
    $url

URL pointing to panel detail view.

$error


    protected
        FlattenException|null
    $error

Error while saving the panel

$_behaviors


    private
        array<string|int, Behavior>|null
    $_behaviors

the attached behaviors (behavior name => behavior). This is null when not initialized.

$_events


    private
        array<string|int, mixed>
    $_events
     = []

the attached event handlers (event name => handlers)

$_eventWildcards


    private
        array<string|int, mixed>
    $_eventWildcards
     = []

the event handlers attached for wildcard patterns (event name wildcard => handlers)

$_models


    private
        array<string|int, mixed>
    $_models

db queries info extracted to array as models, to use with data provider.

$_profileLogs


    private
        array<string|int, mixed>
    $_profileLogs

current database profile logs

$_timings


    private
        array<string|int, mixed>
    $_timings

current database request timings

__call()

Calls the named method which is not a class method.


    public
                    __call(string $name, array<string|int, mixed> $params) : mixed

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.

Parameters

$name : string: the method name
$params : array<string|int, mixed>: method parameters

Return values

mixed —

the method return value

__clone()

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


    public
                    __clone() : mixed

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

__construct()

Constructor.


    public
                    __construct([array<string|int, mixed> $config = [] ]) : mixed

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.

Parameters

$config : array<string|int, mixed> = []: name-value pairs that will be used to initialize the object properties

__get()

Returns the value of a component property.


    public
                    __get(string $name) : mixed

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;.

Parameters

$name : string: the property name

Return values

mixed —

the property value or the value of a behavior's property

__isset()

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


    public
                    __isset(string $name) : bool

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

Parameters

$name : string: the property name or the event name

Return values

bool —

whether the named property is set

__set()

Sets the value of a component property.


    public
                    __set(string $name, mixed $value) : mixed

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;.

Parameters

$name : string: the property name or the event name
$value : mixed: the property value

__unset()

Sets a component property to be null.


    public
                    __unset(string $name) : mixed

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

Parameters

$name : string: the property name

attachBehavior()

Attaches a behavior to this component.


    public
                    attachBehavior(string $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

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 [[Behavior::attach()]] method.

Parameters

$name : string

the name of the behavior.

$behavior : string|array<string|int, mixed>|Behavior

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

a [[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 values

Behavior —

the behavior object

attachBehaviors()

Attaches a list of behaviors to the component.


    public
                    attachBehaviors(array<string|int, mixed> $behaviors) : mixed

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

Parameters

$behaviors : array<string|int, mixed>: list of behaviors to be attached to the component

behaviors()

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


    public
                    behaviors() : array<string|int, mixed>

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 [[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).

Return values

array<string|int, mixed> —

the behavior configurations.

calculateTimings()

Calculates given request profile timings.


    public
                    calculateTimings() : array<string|int, mixed>

Return values

array<string|int, mixed> —

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

canBeExplained()

Check if given query type can be explained.


    public
            static        canBeExplained(string $type) : bool

Parameters

$type : string: query type

Return values

bool

canGetProperty()

Returns a value indicating whether a property can be read.


    public
                    canGetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

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

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.


    public
                    canSetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

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

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be written

className()

Returns the fully qualified name of this class.


    public
            static        className() : string

Return values

string —

the fully qualified name of this class.

countCallerCals()

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


    public
                    countCallerCals() : array<string|int, mixed>

Return values

array<string|int, mixed> —

the number of DB calls indexed by the backtrace hash of the caller.

countDuplicateQuery()

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


    public
                    countDuplicateQuery(mixed $timings) : array<string|int, mixed>

Parameters

$timings : mixed

Return values

array<string|int, mixed>

detachBehavior()

Detaches a behavior from the component.


    public
                    detachBehavior(string $name) : Behavior|null

The behavior's [[Behavior::detach()]] method will be invoked.

Parameters

$name : string: the behavior's name.

Return values

Behavior|null —

the detached behavior. Null if the behavior does not exist.

detachBehaviors()

Detaches all behaviors from the component.


    public
                    detachBehaviors() : mixed

ensureBehaviors()

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


    public
                    ensureBehaviors() : mixed

generateQueryCallersDataProvider()

Creates an ArrayDataProvider for the DB query callers.


    public
                    generateQueryCallersDataProvider(array<string|int, mixed> $modelData) : ArrayDataProvider

Parameters

$modelData : array<string|int, mixed>

Return values

ArrayDataProvider

getBehavior()

Returns the named behavior object.


    public
                    getBehavior(string $name) : Behavior|null

Parameters

$name : string: the behavior name

Return values

Behavior|null —

the behavior object, or null if the behavior does not exist

getBehaviors()

Returns all behaviors attached to this component.


    public
                    getBehaviors() : array<string|int, Behavior>

Return values

array<string|int, Behavior> —

list of behaviors attached to this component

getDb()

Returns a reference to the DB component associated with the panel


    public
                    getDb() : Connection

Return values

Connection

getDetail()


    public
                    getDetail() : string

Return values

string —

content that is displayed in debugger detail view

getError()


    public
                    getError() : FlattenException|null

Return values

FlattenException|null

getExcessiveCallers()

Get the backtrace hashes that make excessive DB cals.


    public
                    getExcessiveCallers() : array<string|int, mixed>

Return values

array<string|int, mixed> —

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

getExcessiveCallersCount()

Get the number of excessive caller(s).


    public
                    getExcessiveCallersCount() : int

Return values

int

getName()


    public
                    getName() : string

Return values

string —

name of the panel

getProfileLogs()

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


    public
                    getProfileLogs() : array<string|int, mixed>

Return values

array<string|int, mixed>

getSummary()


    public
                    getSummary() : string

Return values

string —

content that is displayed at debug toolbar

getSummaryName()


    public
                    getSummaryName() : string

Return values

string —

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

getTraceLine()

Returns a trace line


    public
                    getTraceLine(array<string|int, mixed> $options) : string

Parameters

$options : array<string|int, mixed>: The array with trace

Return values

string —

the trace line

getTypes()

Returns array query types


    public
                    getTypes() : array<string|int, mixed>

Return values

array<string|int, mixed>

getUrl()


    public
                    getUrl([null|array<string|int, mixed> $additionalParams = null ]) : string

Parameters

$additionalParams : null|array<string|int, mixed> = null: Optional additional parameters to add to the route

Return values

string —

URL pointing to panel detail view

hasError()


    public
                    hasError() : bool

Return values

bool

hasEventHandlers()

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


    public
                    hasEventHandlers(string $name) : bool

Parameters

$name : string: the event name

Return values

bool —

whether there is any handler attached to the event.

hasMethod()

Returns a value indicating whether a method is defined.


    public
                    hasMethod(string $name[, bool $checkBehaviors = true ]) : bool

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

Parameters

$name : string: the property name
$checkBehaviors : bool = true: whether to treat behaviors' methods as methods of this component

Return values

bool —

whether the method is defined

hasProperty()

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


    public
                    hasProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

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

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property is defined

init()

Initializes the object.


    public
                    init() : mixed

isEnabled()

Checks whether this panel is enabled.


    public
                    isEnabled() : bool

Return values

bool —

whether this panel is enabled.

isNumberOfCallsExcessive()

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


    public
                    isNumberOfCallsExcessive(int $numCalls) : bool

Parameters

$numCalls : int: queries count

Return values

bool

isQueryCountCritical()

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


    public
                    isQueryCountCritical(int $count) : bool

Parameters

$count : int: queries count

Return values

bool

load()

Loads data into the panel


    public
                    load(mixed $data) : mixed

Parameters

$data : mixed

off()

Detaches an existing event handler from this component.


    public
                    off(string $name[, callable|null $handler = null ]) : bool

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.

Parameters

$name : string: event name
$handler : callable|null = null: the event handler to be removed. If it is null, all handlers attached to the named event will be removed.

Return values

bool —

if a handler is found and detached

on()

Attaches an event handler to an event.


    public
                    on(string $name, callable $handler[, mixed $data = null ][, bool $append = true ]) : mixed

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 [[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.');
});

Parameters

$name : string: the event name
$handler : callable: the event handler
$data : mixed = null: 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 [[Event::data]].
$append : bool = true: 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.

save()

Saves data to be later used in debugger detail view.


    public
                    save() : mixed

Return values

mixed —

data to be saved

setError()


    public
                    setError(FlattenException $error) : mixed

Parameters

$error : FlattenException

sumDuplicateQueries()

Returns sum of all duplicated queries


    public
                    sumDuplicateQueries(mixed $modelData) : int

Parameters

$modelData : mixed

Return values

int

trigger()

Triggers an event.


    public
                    trigger(string $name[, Event|null $event = null ]) : mixed

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

Parameters

$name : string: the event name
$event : Event|null = null: the event instance. If not set, a default [[Event]] object will be created.

getLogMessages()

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


    protected
                    getLogMessages([int $levels = 0 ][, array<string|int, mixed> $categories = [] ][, array<string|int, mixed> $except = [] ][, bool $stringify = false ]) : array<string|int, mixed>

Parameters

$levels : int = 0: the message levels to filter by. This is a bitmap of level values. Value 0 means allowing all levels.
$categories : array<string|int, mixed> = []: the message categories to filter by. If empty, it means all categories are allowed.
$except : array<string|int, mixed> = []: the message categories to exclude. If empty, it means all categories are allowed.
$stringify : bool = false: Convert non-string (such as closures) to strings

Return values

array<string|int, mixed> —

the filtered messages.

getModels()

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


    protected
                    getModels() : array<string|int, mixed>

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

Return values

array<string|int, mixed> —

models

getQueryType()

Returns database query type.


    protected
                    getQueryType(string $timing) : string

Parameters

$timing : string: timing procedure string

Return values

string —

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

getTotalQueryTime()

Returns total query time.


    protected
                    getTotalQueryTime(array<string|int, mixed> $timings) : int

Parameters

$timings : array<string|int, mixed>

Return values

int —

total time

hasExplain()


    protected
                    hasExplain() : bool

Return values

bool —

Whether the DB component has support for EXPLAIN queries

attachBehaviorInternal()

Attaches a behavior to this component.


    private
                    attachBehaviorInternal(string|int $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

Parameters

$name : string|int: the name of the behavior. If this is an integer, it means the behavior is an anonymous one. Otherwise, the behavior is a named one and any existing behavior with the same name will be detached first.
$behavior : string|array<string|int, mixed>|Behavior: the behavior to be attached

Return values

Behavior —

the attached behavior.

DbPanel extends Panel in package Application

Tags

Table of Contents

Properties

Methods

Properties

$actions

$behaviors read-only

$criticalQueryThreshold

$data

$db

$dbEventNames

Tags

$defaultFilter

Tags

$defaultOrder

Tags

$detail read-only

$excessiveCallers read-only

$excessiveCallerThreshold

Tags

$id

$ignoredPathsInBacktrace

Tags

$module

$name read-only

$profileLogs read-only

$summary read-only

$summaryName read-only

$tag

$url read-only

$error

Tags

$_behaviors

$_events

$_eventWildcards

Tags

$_models

$_profileLogs

$_timings

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

Parameters

__get()

Parameters

Tags

Return values

__isset()

Parameters

Tags

Return values

__set()

Parameters

Tags

__unset()

Parameters

Tags

attachBehavior()

Parameters

Tags

Return values

attachBehaviors()

Parameters

Tags

behaviors()

Return values

DbPanel extends Panel
in package

Application