README.md 1.9KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. Debug Extension for Yii 2
  2. =========================
  3. This extension provides a debugger for [Yii framework 2.0](http://www.yiiframework.com) applications. When this extension is used,
  4. a debugger toolbar will appear at the bottom of every page. The extension also provides
  5. a set of standalone pages to display more detailed debug information.
  6. For license information check the [LICENSE](LICENSE.md)-file.
  7. Documentation is at [docs/guide/README.md](docs/guide/README.md).
  8. [![Latest Stable Version](https://poser.pugx.org/yiisoft/yii2-debug/v/stable.png)](https://packagist.org/packages/yiisoft/yii2-debug)
  9. [![Total Downloads](https://poser.pugx.org/yiisoft/yii2-debug/downloads.png)](https://packagist.org/packages/yiisoft/yii2-debug)
  10. Installation
  11. ------------
  12. The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
  13. Either run
  14. ```
  15. php composer.phar require --prefer-dist yiisoft/yii2-debug
  16. ```
  17. or add
  18. ```
  19. "yiisoft/yii2-debug": "~2.0.0"
  20. ```
  21. to the require section of your `composer.json` file.
  22. Usage
  23. -----
  24. Once the extension is installed, simply modify your application configuration as follows:
  25. ```php
  26. return [
  27. 'bootstrap' => ['debug'],
  28. 'modules' => [
  29. 'debug' => [
  30. 'class' => 'yii\debug\Module',
  31. ],
  32. // ...
  33. ],
  34. ...
  35. ];
  36. ```
  37. You will see a debugger toolbar showing at the bottom of every page of your application.
  38. You can click on the toolbar to see more detailed debug information.
  39. Open Files in IDE
  40. -----
  41. You can create a link to open files in your favorite IDE with this configuration:
  42. ```php
  43. return [
  44. 'bootstrap' => ['debug'],
  45. 'modules' => [
  46. 'debug' => [
  47. 'class' => 'yii\debug\Module',
  48. 'traceLine' => '<a href="phpstorm://open?url={file}&line={line}">{file}:{line}</a>',
  49. ],
  50. // ...
  51. ],
  52. ...
  53. ];
  54. ```
  55. You must make some changes to your OS, see this example: https://github.com/aik099/PhpStormProtocol