https://github.com/yiisoft/yii-debug

Yii debug panel extension
https://github.com/yiisoft/yii-debug

debug debugbar hacktoberfest yii3

Last synced: 9 months ago
JSON representation

Yii debug panel extension

• Host: GitHub
• URL: https://github.com/yiisoft/yii-debug
• Owner: yiisoft
• License: bsd-3-clause
• Created: 2018-08-02T16:00:10.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-10-22T07:30:59.000Z (about 1 year ago)
• Last Synced: 2024-10-29T14:35:37.679Z (about 1 year ago)
• Topics: debug, debugbar, hacktoberfest, yii3
• Language: PHP
• Homepage: https://www.yiiframework.com/
• Size: 896 KB
• Stars: 32
• Watchers: 21
• Forks: 15
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

          


    

        

    

    
Yii Debug Extension

    


[![Latest Stable Version](https://poser.pugx.org/yiisoft/yii-debug/v)](https://packagist.org/packages/yiisoft/yii-debug)

[![Total Downloads](https://poser.pugx.org/yiisoft/yii-debug/downloads)](https://packagist.org/packages/yiisoft/yii-debug)

[![Build status](https://github.com/yiisoft/yii-debug/actions/workflows/build.yml/badge.svg)](https://github.com/yiisoft/yii-debug/actions/workflows/build.yml)

[![Code coverage](https://codecov.io/gh/yiisoft/yii-debug/graph/badge.svg?token=6FGTORDAP0)](https://codecov.io/gh/yiisoft/yii-debug)

[![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fyiisoft%2Fyii-debug%2Fmaster)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/yii-debug/master)

[![static analysis](https://github.com/yiisoft/yii-debug/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/yii-debug/actions?query=workflow%3A%22static+analysis%22)

[![type-coverage](https://shepherd.dev/github/yiisoft/yii-debug/coverage.svg)](https://shepherd.dev/github/yiisoft/yii-debug)

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

## Requirements

- PHP 8.1 or higher.

## Installation

The package could be installed with [Composer](https://getcomposer.org):

```shell

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:

```php

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`](https://github.com/yiisoft/yii-debug-api) and [`yiisoft/yii-dev-panel`](https://github.com/yiisoft/yii-dev-panel)

to be able to interact with collected data through UI.

## Documentation

- [Guide](docs/guide/en/README.md)

- [Internals](docs/internals.md)

If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that.

You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).

## License

The Yii Debug Extension is free software. It is released under the terms of the BSD License.

Please see [`LICENSE`](./LICENSE.md) for more information.

Maintained by [Yii Software](https://www.yiiframework.com/).

## Support the project

[![Open Collective](https://img.shields.io/badge/Open%20Collective-sponsor-7eadf1?logo=open%20collective&logoColor=7eadf1&labelColor=555555)](https://opencollective.com/yiisoft)

## Follow updates

[![Official website](https://img.shields.io/badge/Powered_by-Yii_Framework-green.svg?style=flat)](https://www.yiiframework.com/)

[![Twitter](https://img.shields.io/badge/twitter-follow-1DA1F2?logo=twitter&logoColor=1DA1F2&labelColor=555555?style=flat)](https://twitter.com/yiiframework)

[![Telegram](https://img.shields.io/badge/telegram-join-1DA1F2?style=flat&logo=telegram)](https://t.me/yii3en)

[![Facebook](https://img.shields.io/badge/facebook-join-1DA1F2?style=flat&logo=facebook&logoColor=ffffff)](https://www.facebook.com/groups/yiitalk)

[![Slack](https://img.shields.io/badge/slack-join-1DA1F2?style=flat&logo=slack)](https://yiiframework.com/go/slack)