Merge pull request #775 from cakephp/fix-dumps

Fix sorting and collapsing of dump output

Author: markstory

src/Cache/Engine/DebugEngine.php

@@ -159,10 +159,10 @@ public function set($key, $value, $ttl = null): bool
     /**
      * @inheritDoc
      */
-    public function setMultiple($data, $ttl = null): bool
+    public function setMultiple($values, $ttl = null): bool
     {
         $start = microtime(true);
-        $result = $this->_engine->setMultiple($data);
+        $result = $this->_engine->setMultiple($values);
         $duration = microtime(true) - $start;
 
         $this->track('set');

src/Log/Engine/DebugKitLog.php

@@ -31,17 +31,17 @@ class DebugKitLog extends BaseLog
     /**
      * Captures log messages in memory
      *
-     * @param string $type The type of message being logged.
+     * @param mixed $level The type of message being logged.
      * @param string $message The message being logged.
      * @param array $context Additional context data
      * @return void
      */
-    public function log($type, $message, array $context = [])
+    public function log($level, $message, array $context = [])
     {
-        if (!isset($this->_logs[$type])) {
-            $this->_logs[$type] = [];
+        if (!isset($this->_logs[$level])) {
+            $this->_logs[$level] = [];
         }
-        $this->_logs[$type][] = [date('Y-m-d H:i:s'), $this->_format($message)];
+        $this->_logs[$level][] = [date('Y-m-d H:i:s'), $this->_format($message)];
     }
 
     /**

src/View/Helper/ToolbarHelper.php

@@ -72,6 +72,11 @@ public function dump($value)
             $restore = true;
             $debugger->setConfig('exportFormatter', HtmlFormatter::class);
         }
+
+        if ($this->sort && is_array($value)) {
+            ksort($value);
+        }
+
         $contents = Debugger::exportVar($value, 25);
         if ($restore) {
             $debugger->setConfig('exportFormatter', $exportFormatter);

templates/layout/panel.php

@@ -22,6 +22,7 @@
 use Cake\TestSuite\TestCase;
 use Cake\View\View;
 use DebugKit\View\Helper\ToolbarHelper;
+use SimpleXmlElement;
 use stdClass;
 
 /**
@@ -78,10 +79,27 @@ public function testDumpCoerceHtml()
             Debugger::configInstance('exportFormatter'),
             'Should restore setting'
         );
+
         // Restore back to original value.
         Debugger::configInstance('exportFormatter', $restore);
     }
 
+    public function testDumpSorted()
+    {
+        $path = '//*[@class="cake-dbg-array-item"]/*[@class="cake-dbg-string"]';
+        $data = ['z' => 1, 'a' => 99, 'm' => 123];
+        $result = $this->Toolbar->dump($data);
+        $xml = new SimpleXmlElement($result);
+        $elements = $xml->xpath($path);
+        $this->assertSame(["'z'", "'a'", "'m'"], array_map('strval', $elements));
+
+        $this->Toolbar->setSort(true);
+        $result = $this->Toolbar->dump($data);
+        $xml = new SimpleXmlElement($result);
+        $elements = $xml->xpath($path);
+        $this->assertSame(["'a'", "'m'", "'z'"], array_map('strval', $elements));
+    }
+
     /**
      * Test makeNeatArray with basic types.
      *

tests/TestCase/View/Helper/ToolbarHelperTest.php

@@ -150,11 +150,14 @@ Toolbar.prototype = {
       // Slide panel into place - css transitions.
       _this.content.addClass('enabled');
       contentArea.html(response);
+      _this.bindVariableSort();
+      _this.bindDebugBlock();
+
       _this.bindNeatArray();
     });
   },
 
-  bindNeatArray: function() {
+  bindVariableSort: function() {
     var sortButton = this.content.find('.neat-array-sort');
     var _this = this;
     sortButton.click(function() {
@@ -165,7 +168,16 @@ Toolbar.prototype = {
       }
       _this.loadPanel(_this.currentPanel());
     });
+  },
+
+  bindDebugBlock: function () {
+    if (window.__cakeDebugBlockInit) {
+        window.__cakeDebugBlockInit();
+    }
+  },
 
+  bindNeatArray: function() {
+    var _this = this;
     var lists = this.content.find('.depth-0');
     lists.find('ul').hide()
       .parent().addClass('expandable collapsed');