Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cakephp/debug_kit
Debug Toolbar for CakePHP applications.
https://github.com/cakephp/debug_kit
cakephp cakephp-plugin debugbar debugging php
Last synced: 3 months ago
JSON representation
Debug Toolbar for CakePHP applications.
- Host: GitHub
- URL: https://github.com/cakephp/debug_kit
- Owner: cakephp
- License: other
- Created: 2009-12-12T03:24:12.000Z (over 14 years ago)
- Default Branch: 5.x
- Last Pushed: 2024-04-05T04:15:05.000Z (3 months ago)
- Last Synced: 2024-04-05T05:24:58.929Z (3 months ago)
- Topics: cakephp, cakephp-plugin, debugbar, debugging, php
- Language: PHP
- Homepage: http://cakephp.org
- Size: 6.06 MB
- Stars: 853
- Watchers: 77
- Forks: 573
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Lists
- awesome-cakephp - DebugKit plugin - The de-facto standard for debugging. (Debugging)
- awesome-stars - debug_kit - Debug Toolbar for CakePHP applications. (PHP)
README
# CakePHP DebugKit
[](https://codecov.io/github/cakephp/debug_kit)
[](LICENSE.txt)
[](https://packagist.org/packages/cakephp/debug_kit)
DebugKit provides a debugging toolbar and enhanced debugging tools for CakePHP
applications. It lets you quickly see configuration data, log messages, SQL
queries, and timing data for your application.
:warning: DebugKit is only intended for use in single-user local development
environments. You should avoid using DebugKit in shared development
environments, staging environments, or any environment where you need to keep
configuration data and environment variables hidden. :warning:
## Requirements
* SQLite (pdo_sqlite) or another database driver that CakePHP can talk to. By
default DebugKit will use SQLite, if you need to use a different database see the Database Configuration section in the documentation linked below.
For details and older versions see [version map](https://github.com/cakephp/debug_kit/wiki#version-map).
## Installation
* Install the plugin with [Composer](https://getcomposer.org/) from your CakePHP Project's ROOT directory (where the **composer.json** file is located)
```sh
php composer.phar require --dev cakephp/debug_kit:"^5.0"
```
* [Load the plugin](https://book.cakephp.org/5/en/plugins.html#loading-a-plugin)
```php
// src/Application.php
$this->addPlugin('DebugKit');
```
* Set `'debug' => true,` in `config/app.php`.
## Is DebugKit not working?
If you don't see a CakePHP icon on the bottom right of your page DebugKit is not be
working correctly. Some common problems are:
1. Your PHP environment doesn't have SQLite installed. Check your application
logs to confirm if this happening. You can either configure DebugKit to use
a different database, or install the PDO SQLite 3 extension.
2. Your hostname needs to be added to the `DebugKit.safeTld`. If your local
domain isn't a known development environment name, DebugKit will disable
itself to protect a potentially non-development environment.
3. If you are using the [Authorization Plugin](https://github.com/cakephp/authorization)
you need to set `DebugKit.ignoreAuthorization` to `true` in your config.
## Reporting Issues
If you have a problem with DebugKit please open an issue on [GitHub](https://github.com/cakephp/debug_kit/issues).
## Contributing
If you'd like to contribute to DebugKit, check out the
[roadmap](https://github.com/cakephp/debug_kit/wiki/roadmap) for any
planned features. You can [fork](https://help.github.com/articles/fork-a-repo)
the project, add features, and send [pull
requests](https://help.github.com/articles/using-pull-requests) or open
[issues](https://github.com/cakephp/debug_kit/issues).
## Documentation
Documentation for DebugKit can be found in the
[CakePHP documentation](https://book.cakephp.org/debugkit/5/en/index.html).
## Panels
Panels by other plugins:
- `L10n` by [Setup plugin](https://github.com/dereuromark/cakephp-setup) to show current localization for Date, DateTime, Time objects/values.