Skip to content

yiisoft/yii-debug

Yii

Yii Debug Extension


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

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.

Requirements

  • PHP 8.1 or higher.

Installation

The package could be installed with 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 the necessary collectors only to reduce functions overriding and improve performance.

General 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

If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.

License

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

Maintained by Yii Software.

Support the project

Open Collective

Follow updates

Official website Twitter Telegram Facebook Slack