Class yii\debug\Module
Inheritance | yii\debug\Module » yii\base\Module |
---|---|
Implements | yii\base\BootstrapInterface |
Available since extension's version | 2.0 |
Source Code | https://github.com/yiisoft/yii2-debug/blob/master/src/Module.php |
The Yii Debug Module provides the debug toolbar and debugger
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
$allowedHosts | array | The list of hosts that are allowed to access this module. | yii\debug\Module |
$allowedIPs | array | The list of IPs that are allowed to access this module. | yii\debug\Module |
$controllerNamespace | yii\debug\Module | ||
$dataPath | string | The directory storing the debugger data files. | yii\debug\Module |
$defaultPanel | string | The name of the panel that should be visible when opening the debug panel. | yii\debug\Module |
$dirMode | integer | The permission to be set for newly created directories. | yii\debug\Module |
$disableIpRestrictionWarning | boolean | Whether to disable IP address restriction warning triggered by checkAccess function | yii\debug\Module |
$enableDebugLogs | boolean | Whether to enable message logging for the requests about debug module actions. | yii\debug\Module |
$fileMode | integer | The permission to be set for newly created debugger data files. | yii\debug\Module |
$historySize | integer | The maximum number of debug data files to keep. | yii\debug\Module |
$logTarget | yii\debug\LogTarget | yii\debug\Module | |
$panels | array|yii\debug\Panel[] | List of debug panels. | yii\debug\Module |
$traceLine | mixed | The string with placeholders to be be substituted or an anonymous function that returns the trace line string. | yii\debug\Module |
Public Methods
Method | Description | Defined By |
---|---|---|
beforeAction() | yii\debug\Module | |
bootstrap() | yii\debug\Module | |
getToolbarHtml() | Gets toolbar HTML | yii\debug\Module |
getYiiLogo() | Returns the logo URL to be used in <img src=" |
yii\debug\Module |
init() | yii\debug\Module | |
renderToolbar() | Renders mini-toolbar at the end of page body. | yii\debug\Module |
setDebugHeaders() | Setting headers to transfer debug data in AJAX requests without interfering with the request itself. | yii\debug\Module |
setYiiLogo() | Sets the logo URL to be used in <img src=" |
yii\debug\Module |
Protected Methods
Method | Description | Defined By |
---|---|---|
checkAccess() | Checks if current user is allowed to access the module | yii\debug\Module |
corePanels() | yii\debug\Module | |
defaultVersion() | yii\debug\Module | |
initPanels() | Initializes panels. | yii\debug\Module |
resetGlobalSettings() | Resets potentially incompatible global settings done in app config. | yii\debug\Module |
Constants
Constant | Value | Description | Defined By |
---|---|---|---|
DEFAULT_IDE_TRACELINE | '{text}' | yii\debug\Module |
Property Details
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
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.
The directory storing the debugger data files. This can be specified using a path alias.
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 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.
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.
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;
}
Method Details
public void beforeAction ( $action ) | ||
$action |
public function beforeAction($action)
{
if (!$this->enableDebugLogs) {
foreach ($this->get('log')->targets as $target) {
$target->enabled = false;
}
}
if (!parent::beforeAction($action)) {
return false;
}
// do not display debug toolbar when in debug view mode
Yii::$app->getView()->off(View::EVENT_END_BODY, [$this, 'renderToolbar']);
Yii::$app->getResponse()->off(Response::EVENT_AFTER_PREPARE, [$this, 'setDebugHeaders']);
if ($this->checkAccess()) {
$this->resetGlobalSettings();
return true;
}
if ($action->id === 'toolbar') {
// Accessing toolbar remotely is normal. Do not throw exception.
return false;
}
throw new ForbiddenHttpException('You are not allowed to access this page.');
}
public void bootstrap ( $app ) | ||
$app |
public function bootstrap($app)
{
$this->logTarget = $app->getLog()->targets['debug'] = new LogTarget($this);
// delay attaching event handler to the view component after it is fully configured
$app->on(Application::EVENT_BEFORE_REQUEST, function () use ($app) {
$app->getView()->on(View::EVENT_END_BODY, [$this, 'renderToolbar']);
$app->getResponse()->on(Response::EVENT_AFTER_PREPARE, [$this, 'setDebugHeaders']);
});
$app->getUrlManager()->addRules([
[
'class' => 'yii\web\UrlRule',
'route' => $this->id,
'pattern' => $this->id,
'suffix' => false
],
[
'class' => 'yii\web\UrlRule',
'route' => $this->id . '/<controller>/<action>',
'pattern' => $this->id . '/<controller:[\w\-]+>/<action:[\w\-]+>',
'suffix' => false
]
], false);
}
Checks if current user is allowed to access the module
protected boolean checkAccess ( ) | ||
return | boolean |
If access is granted |
---|
protected function checkAccess()
{
$ip = Yii::$app->getRequest()->getUserIP();
foreach ($this->allowedIPs as $filter) {
if ($filter === '*' || $filter === $ip || (($pos = strpos($filter, '*')) !== false && !strncmp($ip, $filter, $pos))) {
return true;
}
}
foreach ($this->allowedHosts as $hostname) {
$filter = gethostbyname($hostname);
if ($filter === $ip) {
return true;
}
}
(!$this->disableIpRestrictionWarning) {
ii::warning('Access to debugger is denied due to IP address restriction. The requesting IP address is ' . $ip, __METHOD__);
return false;
}
protected array corePanels ( ) | ||
return | array |
Default set of panels |
---|
protected function corePanels()
{
return [
'config' => ['class' => 'yii\debug\panels\ConfigPanel'],
'request' => ['class' => 'yii\debug\panels\RequestPanel'],
'log' => ['class' => 'yii\debug\panels\LogPanel'],
'profiling' => ['class' => 'yii\debug\panels\ProfilingPanel'],
'db' => ['class' => 'yii\debug\panels\DbPanel'],
'event' => ['class' => 'yii\debug\panels\EventPanel'],
'assets' => ['class' => 'yii\debug\panels\AssetPanel'],
'mail' => ['class' => 'yii\debug\panels\MailPanel'],
'timeline' => ['class' => 'yii\debug\panels\TimelinePanel'],
'user' => ['class' => 'yii\debug\panels\UserPanel'],
'router' => ['class' => 'yii\debug\panels\RouterPanel'],
];
}
protected void defaultVersion ( ) |
protected function defaultVersion()
{
$packageInfo = Json::decode(file_get_contents(dirname(__DIR__) . DIRECTORY_SEPARATOR . 'composer.json'));
$extensionName = $packageInfo['name'];
if (isset(Yii::$app->extensions[$extensionName])) {
return Yii::$app->extensions[$extensionName]['version'];
}
return parent::defaultVersion();
}
Gets toolbar HTML
public void getToolbarHtml ( ) |
public function getToolbarHtml()
{
$url = Url::toRoute(['/' . $this->id . '/default/toolbar',
'tag' => $this->logTarget->tag,
]);
return '<div id="yii-debug-toolbar" data-url="' . Html::encode($url) . '" style="display:none" class="yii-debug-toolbar-bottom"></div>';
}
Returns the logo URL to be used in <img src="
public static string getYiiLogo ( ) | ||
return | string |
The logo URL |
---|
public static function getYiiLogo()
{
return self::$_yiiLogo;
}
public void init ( ) |
public function init()
{
parent::init();
$this->dataPath = Yii::getAlias($this->dataPath);
if (Yii::$app instanceof \yii\web\Application) {
$this->initPanels();
}
}
Initializes panels.
protected void initPanels ( ) |
protected function initPanels()
{
// merge custom panels and core panels so that they are ordered mainly by custom panels
if (empty($this->panels)) {
$this->panels = $this->corePanels();
} else {
$corePanels = $this->corePanels();
foreach ($corePanels as $id => $config) {
if (isset($this->panels[$id])) {
unset($corePanels[$id]);
}
}
$this->panels = array_filter(array_merge($corePanels, $this->panels));
}
foreach ($this->panels as $id => $config) {
if (is_string($config)) {
$config = ['class' => $config];
}
$config['module'] = $this;
$config['id'] = $id;
$this->panels[$id] = Yii::createObject($config);
if ($this->panels[$id] instanceof Panel && !$this->panels[$id]->isEnabled()) {
unset($this->panels[$id]);
}
}
}
Renders mini-toolbar at the end of page body.
public void renderToolbar ( $event ) | ||
$event | \yii\base\Event |
public function renderToolbar($event)
{
if (!$this->checkAccess() || Yii::$app->getRequest()->getIsAjax()) {
return;
}
/* @var $view View */
$view = $event->sender;
echo $view->renderDynamic('return Yii::$app->getModule("' . $this->id . '")->getToolbarHtml();');
// echo is used in order to support cases where asset manager is not available
echo '<style>' . $view->renderPhpFile(__DIR__ . '/assets/toolbar.css') . '</style>';
echo '<script>' . $view->renderPhpFile(__DIR__ . '/assets/toolbar.js') . '</script>';
}
Resets potentially incompatible global settings done in app config.
protected void resetGlobalSettings ( ) |
protected function resetGlobalSettings()
{
Yii::$app->assetManager->bundles = [];
}
Setting headers to transfer debug data in AJAX requests without interfering with the request itself.
public void setDebugHeaders ( $event ) | ||
$event | \yii\base\Event |
public function setDebugHeaders($event)
{
if (!$this->checkAccess()) {
return;
}
$url = Url::toRoute(['/' . $this->id . '/default/view',
'tag' => $this->logTarget->tag,
]);
$event->sender->getHeaders()
->set('X-Debug-Tag', $this->logTarget->tag)
->set('X-Debug-Duration', number_format((microtime(true) - YII_BEGIN_TIME) * 1000 + 1))
->set('X-Debug-Link', $url);
}
Sets the logo URL to be used in <img src="
public static void setYiiLogo ( $logo ) | ||
$logo | string |
The logo URL |
public static function setYiiLogo($logo)
{
self::$_yiiLogo = $logo;
}