PHPackages kilbiller/debug\_kit - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Debugging & Profiling](/categories/debugging) 4. / 5. kilbiller/debug\_kit ActiveCakephp-plugin[Debugging & Profiling](/categories/debugging) kilbiller/debug\_kit ==================== A fork of CakePHP Debug Kit 4.0.1(8y ago)06.3kMITPHPPHP >=5.3.0 Since Aug 23Pushed 8y ago1 watchersCompare [ Source](https://github.com/kilbiller/debug_kit)[ Packagist](https://packagist.org/packages/kilbiller/debug_kit)[ Docs](https://github.com/kilbiller/debug_kit)[ RSS](/packages/kilbiller-debug-kit/feed)WikiDiscussions master Synced 1w ago READMEChangelog (3)Dependencies (2)Versions (48)Used By (0) CakePHP DebugKit [![Build Status](https://camo.githubusercontent.com/dd500019ae4be9dcdb299e1e5370454541ac78c1bee86997e276394e77bca89e/68747470733a2f2f7365637572652e7472617669732d63692e6f72672f63616b657068702f64656275675f6b69742e706e673f6272616e63683d6d6173746572)](http://travis-ci.org/cakephp/debug_kit) ================================================================================================================================================================================================================================================================================================================ [](#cakephp-debugkit-) DebugKit provides a debugging toolbar and enhanced debugging tools for CakePHP applications. Requirements ------------ [](#requirements) The master branch has the following requirements: - CakePHP 2.2.0 or greater. - PHP 5.3.0 or greater. Installation ------------ [](#installation) *Using Composer* Install the plugin with [Composer](https://getcomposer.org/) from the directory, where your project's `composer.json` is located: ``` php composer.phar require cakephp/debug_kit "^2.2.0" ``` > Consider using "--dev", if you only want to include DebugKit for your development environment. Because this plugin has the type `cakephp-plugin` set in it's own `composer.json`, composer knows to install it inside your `/Plugin` directory, rather than in the usual vendors file. It is recommended that you add `/Plugin/DebugKit` to your .gitignore file. (Why? [read this](http://getcomposer.org/doc/faqs/should-i-commit-the-dependencies-in-my-vendor-directory.md).) *\[Manual\]* - Download the [DebugKit archive](https://github.com/cakephp/debug_kit/zipball/2.2). - Unzip that download. - Rename the resulting folder to `DebugKit` - Then copy this folder into `app/Plugin/` *\[GIT Submodule\]* In your app directory type: ``` git submodule add --branch 2.2 git://github.com/cakephp/debug_kit.git Plugin/DebugKit git submodule init git submodule update ``` *\[GIT Clone\]* In your plugin directory type ``` git clone --single-branch --branch 2.2 git://github.com/cakephp/debug_kit.git DebugKit ``` ### Enable plugin [](#enable-plugin) - In 2.x, you [need to enable the plugin](http://book.cakephp.org/2.0/en/plugins/how-to-install-plugins.html#enable-the-plugin)in your `app/Config/bootstrap.php` file. If you are already using `CakePlugin::loadAll();`, then the following is not necessary.: ``` CakePlugin::load('DebugKit'); ``` - Include the toolbar component in your `app/Controller/AppController.php`: ``` class AppController extends Controller { public $components = array('DebugKit.Toolbar'); } ``` - Set `Configure::write('debug', 1);` in `app/Config/core.php`. - Make sure to remove the 'sql\_dump' element from your layout (usually `app/View/Layouts/default.ctp`), if you want to experience the awesome that is the DebugKit SQL log. Reporting Issues ---------------- [](#reporting-issues) If you have a problem with DebugKit please open an issue on [GitHub](https://github.com/cakephp/debug_kit/issues). Contributing ------------ [](#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). Versions -------- [](#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.0.0` is compatible with CakePHP 2.0.x only. It will not work with previous CakePHP versions. - `2.2.0` is compatible with CakePHP 2.2.0 and greater. It will not work with older versions of CakePHP as this release uses new API's available in 2.2. - `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. - `3.x.x` are compatible with CakePHP 3.0.0 and greater. These versions are developed in the `master` branch. Documentation ============= [](#documentation) Toolbar Panels -------------- [](#toolbar-panels) The DebugKit Toolbar is comprised of several panels, which are shown by clicking the CakePHP icon in the upper right-hand corner of your browser after DebugKit has been installed and loaded. Each panel is comprised of a panel class and view element. Typically, a panel handles the collection and display of a single type of information such as Logs or Request information. You can choose to panels from the toolbar or add your own custom panels. ### Built-in Panels [](#built-in-panels) There are several built-in panels, they are: - **History** Allows access to previous request information, useful when debugging actions with redirects. - **Request** Displays information about the current request, GET, POST, Cake Parameters, Current Route information and Cookies if the `CookieComponent`is in you controller's components. - **Session** Display the information currently in the Session. - **Timer** Display any timers that were set during the request see `DebugKitDebugger` for more information. Also displays memory use at component callbacks as well as peak memory used. - **Sql Logs** Displays sql logs for each database connection. - **Log** Display any entries made to the log files this request. - **Variables** Display View variables set in controller. - **Environment** Display environment variables related to PHP + CakePHP. Configuration ------------- [](#configuration) The toolbar has a few configuration settings. Settings are passed in the component declaration like normal component configuration. ``` public $components = array( 'DebugKit.Toolbar' => array(/* array of settings */) ); ``` ### Configuring Panels [](#configuring-panels) You can customize the toolbar to show your custom panels or hide any built-in panel when adding it toolbar to your components. ``` public $components = array('DebugKit.Toolbar' => array( 'panels' => array('MyCustom', 'timer'=>false) ) ); ``` Would display your custom panel and all built-in panels except the 'Timer' panel. #### Controlling Panels [](#controlling-panels) Using the panels key you can specify which panels you want to load, as well as the order in which you want the panels loaded. ``` public $components = array( 'DebugKit.Toolbar' => array('panels' => array('MyCustom', 'timer' => false)) ); ``` Would add your custom panel `MyCustomPanel` to the toolbar and exclude the default `Timer` panel. In addition to choosing which panels you want, you can pass options into the `__construct` of the panels. For example the built-in `History` panel uses the `history` key to set the number of historical requests to track. ``` public $components = array( 'DebugKit.Toolbar' => array('history' => 10) ); ``` Would load the `History` panel and set its history level to 10. The `panels` key is not passed to the Panel constructor. #### forceEnable [](#forceenable) The `forceEnable` setting is new in DebugKit 1.1. It allows you to force the toolbar to display regardless of the value of `Configure::read('debug');`. This is useful when profiling an application with debug kit as you can enable the toolbar even when running the application in production mode. #### autoRun [](#autorun) autoRun is a new configuration setting for DebugKit 1.2. It allows you to control whether or not the toolbar is displayed automatically or whether you would like to use a query string parameter to enable it. Set this configuration key to false to use query string parameter toggling of the toolbar. ``` public $components = array( 'DebugKit.Toolbar' => array('autoRun' => false) ); ``` When visiting a page you can add `?debug=true` to the url and the toolbar will be visible. Otherwise it will stay hidden and not execute. Developing Your Own Panels -------------------------- [](#developing-your-own-panels) You can create your own custom panels for DebugKit to help in debugging your applications. ### Panel Classes [](#panel-classes) Panel Classes simply need to be placed in`Panel` directory inside a `Lib` path. The filename should match the classname, so the class `MyCustomPanel` would be expected to have a filename of `app/Lib/Panel/MyCustomPanel.php`. ``` App::uses('DebugPanel', 'DebugKit.Lib'); /** * My Custom Panel */ class MyCustomPanel extends DebugPanel { ... } ``` See also the example `Test/test_app/Plugin/DebugkitTestPlugin/Lib/Panel/PluginTestPanel.php`. Notice that custom panels are required to subclass the `DebugPanel` class. Panels can define the `css` and `javascript` properties to include additional CSS or javascript on the page. Both properties should be an array. ``` class MyCustomPanel extends DebugPanel { public $javascript = array( '/my_plugin/js/custom_panel.js' ); } ``` ### Callbacks [](#callbacks) Panel objects have 2 callbacks, that allow them to hook into and introspect on the current request. ``` startup(Controller $controller) ``` Each panel's `startup()` method is called during component `startup()` process. `$controller` is a reference to the current controller object. ``` beforeRender(Controller $controller) ``` Much like `startup()` `beforeRender()` is called during the Component beforeRender() process. Again `$controller` is a reference to the current controller. Normally at this point you could do additional introspection on the controller. The return of a panels `beforeRender()` is automatically passed to the View by the Toolbar Component. Therefore, under normal use you do not need to explicitly set variables to the controller. #### Example of beforeRender Callback [](#example-of-beforerender-callback) ``` /** * beforeRender callback - grabs request params * * @return array */ public function beforeRender(Controller $controller) { return $controller->params; } ``` This would return cake's internal params array. The return of a panel's `beforeRender()` is available in you Panel element as `$content` ### Panel Elements [](#panel-elements) Each Panel is expected to have a view element that renders the content from the panel. The element name must be the underscored inflection of the class name. For example `SessionPanel` has an element named `session_panel.ctp`, and sqllogPanel has an element named `sqllog_panel.ctp`. These elements should be located in the root of your `View/Elements` directory. #### Custom Titles and Elements [](#custom-titles-and-elements) Panels should pick up their title and element name by convention. However, if you need to choose a custom element name or title, there are properties to allow that configuration. - `$title` - Set a custom title for use in the toolbar. This title will be used as the panels button. - `$elementName` - Set a custom element name to be used to render the panel. ### Panels as Cake Plugins [](#panels-as-cake-plugins) Panels provided by [Cake Plugins](http://book.cakephp.org/2.0/en/plugins.html) work almost entirely the same as other plugins, with one minor difference: You must set `public $plugin` to be the name of the plugin directory, so that the panel's Elements can be located at render time. ``` class MyCustomPanel extends DebugPanel { public $plugin = 'MyPlugin'; ... } ``` To use a plugin panel, use the common CakePHP dot notation for plugins. ``` public $components = array('DebugKit.Toolbar' => array( 'panels' => array('MyPlugin.MyCustom') )); ``` The above would load all the default panels as well as the custom panel from `MyPlugin`. Cache Engine ------------ [](#cache-engine) By default, DebugKit uses File as the engine for internal caching, but if you want to use another cache engine you can customize it by simply adding a cache key inside the components config array. ``` public $components = array('DebugKit.Toolbar' => array( 'cache' => array('engine' => 'Memcache', 'servers' => array('127.0.0.1:11211')) ) ); ``` You can use any cache engine supported by CakePHP, the same way you set in both core.php and bootstrap.php files with the Cache::config() method. Viewing the Toolbar for AJAX Requests ------------------------------------- [](#viewing-the-toolbar-for-ajax-requests) When doing AJAX requests, you will not be able to see an HTML version of the toolbar. However, if you have a browser extension that supports FirePHP, you can view the toolbar in your browser: - [FirePHP 4 chrome](https://chrome.google.com/webstore/detail/firephp4chrome/gpgbmonepdpnacijbbdijfbecmgoojma) - [FirePHP for chrome](https://chrome.google.com/webstore/detail/firephp-for-chrome/goajlbdffkligccnfgibeilhdnnpaead) - [FirePHP for firefox](https://addons.mozilla.org/en-US/firefox/addon/firephp/) Once you have installed the correct extension, you should see the toolbar data output on each AJAX request. ### Health Score 35 — LowBetter than 77% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity18 Limited adoption so far Community20 Small or concentrated contributor base Maturity71 Established project with proven stability Bus Factor1 Top contributor holds 77% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~39 days Recently: every ~145 days Total 46 Last Release 2976d ago Major Versions 2.2.4 → 3.0.0-beta2014-09-28 2.2.5 → 3.0.0-beta22014-11-22 2.2.6 → 3.2.02015-09-20 2.2.x-dev → 3.2.82016-04-16 3.4.11 → 4.0.02018-06-14 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/3019848?v=4)[Rémy Peru](/maintainers/kilbiller)[@kilbiller](https://github.com/kilbiller) --- Top Contributors [![markstory](https://avatars.githubusercontent.com/u/24086?v=4)](https://github.com/markstory "markstory (605 commits)")[![lorenzo](https://avatars.githubusercontent.com/u/37621?v=4)](https://github.com/lorenzo "lorenzo (16 commits)")[![renan](https://avatars.githubusercontent.com/u/28046?v=4)](https://github.com/renan "renan (13 commits)")[![rafb43](https://avatars.githubusercontent.com/u/11786?v=4)](https://github.com/rafb43 "rafb43 (12 commits)")[![ceeram](https://avatars.githubusercontent.com/u/111448?v=4)](https://github.com/ceeram "ceeram (11 commits)")[![ravage84](https://avatars.githubusercontent.com/u/625761?v=4)](https://github.com/ravage84 "ravage84 (11 commits)")[![wa0x6e](https://avatars.githubusercontent.com/u/495709?v=4)](https://github.com/wa0x6e "wa0x6e (10 commits)")[![jperras](https://avatars.githubusercontent.com/u/20675?v=4)](https://github.com/jperras "jperras (10 commits)")[![joelmoss](https://avatars.githubusercontent.com/u/4614?v=4)](https://github.com/joelmoss "joelmoss (8 commits)")[![tersmitten](https://avatars.githubusercontent.com/u/3392962?v=4)](https://github.com/tersmitten "tersmitten (7 commits)")[![josegonzalez](https://avatars.githubusercontent.com/u/65675?v=4)](https://github.com/josegonzalez "josegonzalez (7 commits)")[![gemal](https://avatars.githubusercontent.com/u/69105?v=4)](https://github.com/gemal "gemal (7 commits)")[![h4ck3rm1k3](https://avatars.githubusercontent.com/u/34903?v=4)](https://github.com/h4ck3rm1k3 "h4ck3rm1k3 (7 commits)")[![ichikaway](https://avatars.githubusercontent.com/u/91244?v=4)](https://github.com/ichikaway "ichikaway (6 commits)")[![scottharwell](https://avatars.githubusercontent.com/u/805434?v=4)](https://github.com/scottharwell "scottharwell (5 commits)")[![mcurry](https://avatars.githubusercontent.com/u/29715?v=4)](https://github.com/mcurry "mcurry (5 commits)")[![bcrowe](https://avatars.githubusercontent.com/u/752603?v=4)](https://github.com/bcrowe "bcrowe (5 commits)")[![iamjonbradley](https://avatars.githubusercontent.com/u/38141?v=4)](https://github.com/iamjonbradley "iamjonbradley (4 commits)")[![evilbloodydemon](https://avatars.githubusercontent.com/u/39753?v=4)](https://github.com/evilbloodydemon "evilbloodydemon (4 commits)")[![michal-biarda-orba](https://avatars.githubusercontent.com/u/81220778?v=4)](https://github.com/michal-biarda-orba "michal-biarda-orba (4 commits)") --- Tags debugcakephpkit ### Embed Badge ![Health badge](/badges/kilbiller-debug-kit/health.svg) ``` [![Health](https://phpackages.com/badges/kilbiller-debug-kit/health.svg)](https://phpackages.com/packages/kilbiller-debug-kit) ``` ### Alternatives [johnbillion/query-monitor Query Monitor is the developer tools panel for WordPress and WooCommerce. 1.8k545.8k24](/packages/johnbillion-query-monitor)[cakephp/debug_kit CakePHP Debug Kit 86214.9M182](/packages/cakephp-debug-kit)[helsingborg-stad/municipio A bootstrap theme for creating municipality sites. 4028.6k10](/packages/helsingborg-stad-municipio)[october/rain October Rain Library 1601.7M99](/packages/october-rain)[pressbooks/pressbooks Pressbooks is an open source book publishing tool built on a WordPress multisite platform. Pressbooks outputs books in multiple formats, including PDF, EPUB, web, and a variety of XML flavours, using a theming/templating system, driven by CSS. 45844.8k1](/packages/pressbooks-pressbooks)[mediawiki/maps Adds various mapping features to MediaWiki 85155.1k3](/packages/mediawiki-maps) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)