Rename option

ADmad · ADmad · commit cb391ad5c698 · 2020-06-09T11:39:43.000+05:30
diff --git a/docs/en/index.rst b/docs/en/index.rst
@@ -50,11 +50,11 @@ Configuration
     // Before loading DebugKit
     Configure::write('DebugKit.forceEnable', true);
 
-* ``DebugKit.ignorePaths`` - Regex pattern (including delimiter) to ignore paths.
+* ``DebugKit.ignorePathsPattern`` - Regex pattern (including delimiter) to ignore paths.
    DebugKit won't save data for request URLs that match this regex. Defaults to ``null``::
 
     // Ignore image paths
-    Configure::write('DebugKit.ignorePaths', '/\.(jpg|png|gif)$/');
+    Configure::write('DebugKit.ignorePathsPattern', '/\.(jpg|png|gif)$/');
 
 * ``DebugKit.ignoreAuthorization`` - Set to true to ignore Cake Authorization plugin for DebugKit requests. Disabled by default.
 
diff --git a/src/ToolbarService.php b/src/ToolbarService.php
@@ -67,7 +67,7 @@ class ToolbarService
         ],
         'forceEnable' => false,
         'safeTld' => [],
-        'ignorePaths' => null,
+        'ignorePathsPattern' => null,
     ];
 
     /**
@@ -214,18 +214,18 @@ public function initializePanels()
      */
     public function saveData(ServerRequest $request, ResponseInterface $response)
     {
-        $ignorePaths = $this->getConfig('ignorePaths');
+        $ignorePathsPattern = $this->getConfig('ignorePathsPattern');
         $path = $request->getUri()->getPath();
         $statusCode = $response->getStatusCode();
 
         if (
             strpos($path, 'debug_kit') !== false ||
             strpos($path, 'debug-kit') !== false ||
             (
-                $ignorePaths &&
+                $ignorePathsPattern &&
                 $statusCode >= 200 &&
                 $statusCode <= 299 &&
-                preg_match($ignorePaths, $path)
+                preg_match($ignorePathsPattern, $path)
             )
         ) {
             return false;
diff --git a/tests/TestCase/ToolbarServiceTest.php b/tests/TestCase/ToolbarServiceTest.php
@@ -181,7 +181,7 @@ public function testSaveDataIgnorePaths()
             'body' => '<html><title>test</title><body><p>some text</p></body>',
         ]);
 
-        $bar = new ToolbarService($this->events, ['ignorePaths' => '/\.(jpg|png|gif)$/']);
+        $bar = new ToolbarService($this->events, ['ignorePathsPattern' => '/\.(jpg|png|gif)$/']);
         $this->assertFalse($bar->saveData($request, $response));
 
         $request = new Request([
@@ -194,7 +194,7 @@ public function testSaveDataIgnorePaths()
             'body' => '<html><title>test</title><body><p>some text</p></body>',
         ]);
 
-        $bar = new ToolbarService($this->events, ['ignorePaths' => '/\.(jpg|png|gif)$/']);
+        $bar = new ToolbarService($this->events, ['ignorePathsPattern' => '/\.(jpg|png|gif)$/']);
         $this->assertNotEmpty($bar->saveData($request, $response));
     }
 
