Class yii\debug\Module

The Yii Debug Module provides the debug toolbar and debugger

Public Properties

Public Methods

Protected Methods

Events

Constants

Property Details

$allowedHosts public property

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

public array $allowedHosts = []

$allowedIPs public property

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 or an address with wildcard (e.g. 192.168.0.*) to represent a network segment. The default value is ['127.0.0.1', '::1'], which means the module can only be accessed by localhost.

public array $allowedIPs = ['127.0.0.1', '::1']

$controllerNamespace public property

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.

public string $controllerNamespace = 'yii\debug\controllers'

$dataPath public property

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

public string $dataPath = '@runtime/debug'

$debugHeaders public write-only property

public void setDebugHeaders ( $event )

$defaultPanel public property (available since version 2.0.7)

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

public string $defaultPanel = 'log'

$dirMode public property (available since version 2.0.6)

The permission to be set for newly created directories. This value will be used by PHP \yii\debug\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.

public integer $dirMode = 0775

$enableDebugLogs public property

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.

public boolean $enableDebugLogs = false

$fileMode public property (available since version 2.0.6)

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

public integer $fileMode = null

$historySize public property

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

public integer $historySize = 50

$logTarget public property

public yii\debug\LogTarget $logTarget = null

$panels public property

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.

public array|yii\debug\Panel[] $panels = []

$toolbarHtml public read-only property

public void getToolbarHtml ( )

$traceLine public property (available since version 2.0.7)

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

public mixed $traceLine = self::DEFAULT_IDE_TRACELINE

Method Details

public function beforeAction($action)
{
    if (!parent::beforeAction($action)) {
        return false;
    }

    // your custom code here

    return true; // or false to not run the action
}