yiisoft/yii-debug

Yii Framework Debug Panel Extension

dev-master / 3.0.x-dev 2024-02-07 06:38 UTC

README

68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667

Debug Extension for Yii


This extension provides a debugger for Yii framework 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-file.

Latest Stable Version Total Downloads Build status Scrutinizer Code Quality Code Coverage Mutation testing badge static analysis type-coverage

Installation

The preferred way to install this extension is through composer.

composer require yiisoft/yii-debug --dev

The debug extension also can be installed without the --dev flag if you want to collect data in production. Specify needed collectors only to reduce functions overriding and improve performance.

Usage

Once the extension is installed, modify your config/common/params.php as follows:

return [
    'yiisoft/yii-debug' => [
        'enabled' => true,
    ],
    // ...
];

All included collectors start listen and collect payloads from each HTTP request or console run.

Install both yiisoft/yii-debug-api and yiisoft/yii-dev-panel to be able to interact with collected data through UI.

Documentation

English

Unit testing

The package is tested with PHPUnit. To run tests:

./vendor/bin/phpunit

Mutation testing

The package tests are checked with Infection mutation framework. To run it:

./vendor/bin/infection

Static analysis

The code is statically analyzed with Psalm. To run static analysis:

./vendor/bin/psalm

Support the project

Open Collective

Follow updates

Official website Twitter Telegram Facebook Slack

License

The Debug Extension for Yii is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.