Class yii\debug\Module

The list of hosts that are allowed to access this module. Each array element is a hostname that will be resolved to an IP address that is compared with the IP address of the user. A use case is to use a dynamic DNS (DDNS) to allow access. The default value is [].

The list of IPs that are allowed to access this module. Each array element represents a single IP filter which can be either:

• an IP address (e.g. 1.2.3.4),
• an address with wildcard (e.g. 192.168.0.*) to represent a network segment
• a CIDR range (e.g. 172.16.0.0/12) (available since version 2.1.18). The default value is ['127.0.0.1', '::1'], which means the module can only be accessed by localhost.

A valid PHP callback that returns true if user is allowed to use web shell and false otherwise

The signature is the following:

function (Action|null $action) The action can be null when called from a non action context (like set debug header)

The namespace that controller classes are in. This namespace will be used to load controller classes by prepending it to the controller class name.

If not set, it will use the controllers sub-namespace under the namespace of this module. For example, if the namespace of this module is foo\bar, then the default controller namespace would be foo\bar\controllers.

See also the guide section on autoloading to learn more about defining namespaces and how classes are loaded.

The directory storing the debugger data files. This can be specified using a path alias.

The debug bar default height, as a percentage of the total screen height

The name of the panel that should be visible when opening the debug panel. The default value is 'log'.

The permission to be set for newly created directories. This value will be used by PHP chmod() function. No umask will be applied. Defaults to 0775, meaning the directory is read-writable by owner and group, but read-only for other users.

Whether to disable access callback restriction warning triggered by checkAccess function

Whether to disable IP address restriction warning triggered by checkAccess function

Whether to enable message logging for the requests about debug module actions. You normally do not want to keep these logs because they may distract you from the logs about your applications. You may want to enable the debug logs if you want to investigate how the debug module itself works.

The permission to be set for newly created debugger data files. This value will be used by PHP chmod() function. No umask will be applied. If not set, the permission will be determined by the current environment.

The maximum number of debug data files to keep. If there are more files generated, the oldest ones will be removed.

Page title could be a string or a callable function

...
'pageTitle' => 'Custom Debug Title',
...
// OR
'pageTitle' => function($url) {
    $domain = getDomain($url);
    return $domain . ' debugger';
}

List of debug panels. The array keys are the panel IDs, and values are the corresponding panel class names or configuration arrays. This will be merged with corePanels(). You may reconfigure a core panel via this property by using the same panel ID. You may also disable a core panel by setting it to be false in this property.

Routes of AJAX requests to skip from being displayed in toolbar

The string with placeholders to be be substituted or an anonymous function that returns the trace line string. The placeholders are {file}, {line} and {text} and the string should be as follows:

File: {file} - Line: {line} - Text: {text}

The signature of the anonymous function should be as follows:

function($trace, $panel) {
    // compute line string
    return $line;
}

Used when the virtual, containerized, or remote debug trace paths don't correspond to the developers local paths. Acts on the {file} portion for the $traceLine property.

The array key is the environment's path, while the value is the local desired path.

It will only map the first matched matched key.

Example:

[
    '/app' => '/home/user/project/app',
]

Note that this will not change the displayed text, only the link url.

The UrlRule class to use for rules generated by this module.