first commit
This commit is contained in:
114
vendor/yiisoft/yii2-debug/README.md
vendored
Normal file
114
vendor/yiisoft/yii2-debug/README.md
vendored
Normal file
@ -0,0 +1,114 @@
|
||||
<p align="center">
|
||||
<a href="https://github.com/yiisoft" target="_blank">
|
||||
<img src="https://avatars0.githubusercontent.com/u/993323" height="100px">
|
||||
</a>
|
||||
<h1 align="center">Debug Extension for Yii 2</h1>
|
||||
<br>
|
||||
</p>
|
||||
|
||||
This extension provides a debugger for [Yii framework 2.0](https://www.yiiframework.com) applications. When this extension is used,
|
||||
a debugger toolbar will appear at the bottom of every page. The extension also provides
|
||||
a set of standalone pages to display more detailed debug information.
|
||||
|
||||
For license information check the [LICENSE](LICENSE.md)-file.
|
||||
|
||||
Documentation is at [docs/guide/README.md](docs/guide/README.md).
|
||||
|
||||
[](https://packagist.org/packages/yiisoft/yii2-debug)
|
||||
[](https://packagist.org/packages/yiisoft/yii2-debug)
|
||||
[](https://github.com/yiisoft/yii2-debug/actions)
|
||||
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
The preferred way to install this extension is through [composer](https://getcomposer.org/download/).
|
||||
|
||||
Either run
|
||||
|
||||
```
|
||||
php composer.phar require --prefer-dist yiisoft/yii2-debug
|
||||
```
|
||||
|
||||
or add
|
||||
|
||||
```
|
||||
"yiisoft/yii2-debug": "~2.1.0"
|
||||
```
|
||||
|
||||
to the require section of your `composer.json` file.
|
||||
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
Once the extension is installed, simply modify your application configuration as follows:
|
||||
|
||||
```php
|
||||
return [
|
||||
'bootstrap' => ['debug'],
|
||||
'modules' => [
|
||||
'debug' => [
|
||||
'class' => 'yii\debug\Module',
|
||||
// uncomment and adjust the following to add your IP if you are not connecting from localhost.
|
||||
//'allowedIPs' => ['127.0.0.1', '::1'],
|
||||
],
|
||||
// ...
|
||||
],
|
||||
...
|
||||
];
|
||||
```
|
||||
|
||||
You will see a debugger toolbar showing at the bottom of every page of your application.
|
||||
You can click on the toolbar to see more detailed debug information.
|
||||
|
||||
|
||||
Open Files in IDE
|
||||
-----
|
||||
|
||||
You can create a link to open files in your favorite IDE with this configuration:
|
||||
|
||||
```php
|
||||
return [
|
||||
'bootstrap' => ['debug'],
|
||||
'modules' => [
|
||||
'debug' => [
|
||||
'class' => 'yii\debug\Module',
|
||||
'traceLine' => '<a href="phpstorm://open?url={file}&line={line}">{file}:{line}</a>',
|
||||
// uncomment and adjust the following to add your IP if you are not connecting from localhost.
|
||||
//'allowedIPs' => ['127.0.0.1', '::1'],
|
||||
],
|
||||
// ...
|
||||
],
|
||||
...
|
||||
];
|
||||
```
|
||||
|
||||
You must make some changes to your OS. See these examples:
|
||||
- PHPStorm: https://github.com/aik099/PhpStormProtocol
|
||||
- Sublime Text 3 on Windows or Linux: https://packagecontrol.io/packages/subl%20protocol
|
||||
- Sublime Text 3 on Mac: https://github.com/inopinatus/sublime_url
|
||||
|
||||
#### Virtualized or dockerized
|
||||
|
||||
If your application is run under a virtualized or dockerized environment, it is often the case that the application's
|
||||
base path is different inside of the virtual machine or container than on your host machine. For the links work in those
|
||||
situations, you can configure `tracePathMappings` like this (change the path to your app):
|
||||
|
||||
```php
|
||||
'tracePathMappings' => [
|
||||
'/app' => '/path/to/your/app',
|
||||
],
|
||||
```
|
||||
|
||||
Or you can create a callback for `traceLine` for even more control:
|
||||
|
||||
```php
|
||||
'traceLine' => function($options, $panel) {
|
||||
$filePath = $options['file'];
|
||||
if (StringHelper::startsWith($filePath, Yii::$app->basePath)) {
|
||||
$filePath = '/path/to/your/app' . substr($filePath, strlen(Yii::$app->basePath));
|
||||
}
|
||||
return strtr('<a href="ide://open?url=file://{file}&line={line}">{text}</a>', ['{file}' => $filePath]);
|
||||
},
|
||||
```
|
||||
Reference in New Issue
Block a user