Skip to content

Commit 5de257c

Browse files
committed
Add description to DebugKit configuration options
1 parent 2011746 commit 5de257c

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

config/app.php

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -412,6 +412,30 @@
412412
'Session' => [
413413
'defaults' => 'php',
414414
],
415+
416+
/**
417+
* DebugKit configuration.
418+
*
419+
* Contains an array of configurations to apply to the DebugKit plugin, if loaded.
420+
* Documentation: https://book.cakephp.org/debugkit/5/en/index.html#configuration
421+
*
422+
* ## Options
423+
*
424+
* - `panels` - Enable or disable panels. The key is the panel name, and the value is true to enable,
425+
* or false to disable.
426+
* - `includeSchemaReflection` - Set to true to enable logging of schema reflection queries. Disabled by default.
427+
* - `safeTld` - Set an array of whitelisted TLDs for local development.
428+
* - `forceEnable` - Force DebugKit to display. Careful with this, it is usually safer to simply whitelist
429+
* your local TLDs.
430+
* - `ignorePathsPattern` - Regex pattern (including delimiter) to ignore paths.
431+
* DebugKit won’t save data for request URLs that match this regex.
432+
* - `ignoreAuthorization` - Set to true to ignore Cake Authorization plugin for DebugKit requests.
433+
* Disabled by default.
434+
* - `maxDepth` - Defines how many levels of nested data should be shown in general for debug output.
435+
* Default is 5. WARNING: Increasing the max depth level can lead to an out of memory error.
436+
* - `variablesPanelMaxDepth` - Defines how many levels of nested data should be shown in the variables tab.
437+
* Default is 5. WARNING: Increasing the max depth level can lead to an out of memory error.
438+
*/
415439
'DebugKit' => [
416440
'forceEnable' => filter_var(env('DEBUG_KIT_FORCE_ENABLE', false), FILTER_VALIDATE_BOOLEAN),
417441
'safeTld' => env('DEBUG_KIT_SAFE_TLD', null),

0 commit comments

Comments
 (0)