From 5de257c9a21cabc7a6d9ea70f6ea69609e701ac4 Mon Sep 17 00:00:00 2001 From: Alexander Volle Date: Sun, 19 Jan 2025 16:21:09 +0100 Subject: [PATCH 1/2] Add description to DebugKit configuration options --- config/app.php | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/config/app.php b/config/app.php index 68bf1fcbe..f2ec8d670 100644 --- a/config/app.php +++ b/config/app.php @@ -412,6 +412,30 @@ 'Session' => [ 'defaults' => 'php', ], + + /** + * DebugKit configuration. + * + * Contains an array of configurations to apply to the DebugKit plugin, if loaded. + * Documentation: https://book.cakephp.org/debugkit/5/en/index.html#configuration + * + * ## Options + * + * - `panels` - Enable or disable panels. The key is the panel name, and the value is true to enable, + * or false to disable. + * - `includeSchemaReflection` - Set to true to enable logging of schema reflection queries. Disabled by default. + * - `safeTld` - Set an array of whitelisted TLDs for local development. + * - `forceEnable` - Force DebugKit to display. Careful with this, it is usually safer to simply whitelist + * your local TLDs. + * - `ignorePathsPattern` - Regex pattern (including delimiter) to ignore paths. + * DebugKit won’t save data for request URLs that match this regex. + * - `ignoreAuthorization` - Set to true to ignore Cake Authorization plugin for DebugKit requests. + * Disabled by default. + * - `maxDepth` - Defines how many levels of nested data should be shown in general for debug output. + * Default is 5. WARNING: Increasing the max depth level can lead to an out of memory error. + * - `variablesPanelMaxDepth` - Defines how many levels of nested data should be shown in the variables tab. + * Default is 5. WARNING: Increasing the max depth level can lead to an out of memory error. + */ 'DebugKit' => [ 'forceEnable' => filter_var(env('DEBUG_KIT_FORCE_ENABLE', false), FILTER_VALIDATE_BOOLEAN), 'safeTld' => env('DEBUG_KIT_SAFE_TLD', null), From 7aa34495028a6815ec5e23cdad101bf4f144b000 Mon Sep 17 00:00:00 2001 From: Alexander Volle Date: Sun, 19 Jan 2025 16:27:34 +0100 Subject: [PATCH 2/2] Fix missing comma in existing configuration --- config/app.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config/app.php b/config/app.php index f2ec8d670..2576a8984 100644 --- a/config/app.php +++ b/config/app.php @@ -439,6 +439,6 @@ 'DebugKit' => [ 'forceEnable' => filter_var(env('DEBUG_KIT_FORCE_ENABLE', false), FILTER_VALIDATE_BOOLEAN), 'safeTld' => env('DEBUG_KIT_SAFE_TLD', null), - 'ignoreAuthorization' => env('DEBUG_KIT_IGNORE_AUTHORIZATION', false) + 'ignoreAuthorization' => env('DEBUG_KIT_IGNORE_AUTHORIZATION', false), ], ];