Skip to content
Debug Toolbar for CakePHP applications.
Branch: master
Clone or download
saeideng Merge pull request #662 from cakephp/dev-tld
Don't treat "dev" as a safe TLD by default.
Latest commit b850256 Mar 4, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config Fix that the DeprecationsPanel ignores the errorLevel Oct 1, 2018
src
tests
webroot
.editorconfig Add an editor config file Jan 18, 2015
.gitattributes
.gitignore ignores the common IDE files Dec 21, 2017
.jshintrc Cs fixes Aug 14, 2013
.stickler.yml
.travis.yml
LICENSE.txt Update LICENSE.txt Jan 2, 2019
README.md
composer.json
phpcs.xml.dist Add default phpcs config file Dec 1, 2018
phpunit.xml.dist Only measure code coverage for src/ Mar 17, 2016

README.md

CakePHP DebugKit

Build Status Coverage Status License Total Downloads

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.

⚠️ 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. ⚠️

Requirements

The master branch has the following 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 below.

DebugKit for CakePHP 2.x

If you want DebugKit for your 2.x application, you can use the latest 2.2.y tag or the 2.2 branch.

Installation

  • Install the plugin with Composer from your CakePHP Project's ROOT directory (where the composer.json file is located)
php composer.phar require --dev cakephp/debug_kit:"~3.0"
// src/Application.php
$this->addPlugin('DebugKit');

Prior to 3.6.0

Plugin::load('DebugKit', ['bootstrap' => true, 'routes' => true]);
  • Set 'debug' => true, in config/app.php.

Reporting Issues

If you have a problem with DebugKit please open an issue on GitHub.

Contributing

If you'd like to contribute to DebugKit, check out the roadmap for any planned features. You can fork the project, add features, and send pull requests or open issues.

Versions

DebugKit has several releases, each compatible with different releases of CakePHP. Use the appropriate version by downloading a tag, or checking out the correct branch.

  • 1.0, 1.1, 1.2 are compatible with CakePHP 1.2.x. These releases of DebugKit will not work with CakePHP 1.3. You can also use the 1.2-branch for the mos recent updates and bugfixes.
  • 1.3.0 is compatible with CakePHP 1.3.x only. It will not work with CakePHP 1.2. You can also use the 1.3 branch to get the most recent updates and bugfixes.
  • 2.2.x are compatible with CakePHP 2.2.0 and greater. It is a necessary upgrade for people using CakePHP 2.4 as the naming conventions around loggers changed in that release. 2.2.x is not actively being developed.
  • 3.x is compatible with CakePHP 3.x and is still under active development.

Documentation

Documentation for DebugKit can be found in the CakePHP documentation.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.