5.next: add Plugins Panel

composer.json

@@ -23,7 +23,7 @@
         "source": "https://github.com/cakephp/debug_kit"
     },
     "require": {
-        "cakephp/cakephp": "^5.0",
+        "cakephp/cakephp": "dev-5.next as 5.1.0",
         "composer/composer": "^2.0",
         "doctrine/sql-formatter": "^1.1.3"
     },
@@ -66,5 +66,7 @@
         "allow-plugins": {
             "dealerdirect/phpcodesniffer-composer-installer": true
         }
-    }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
 }

psalm-baseline.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="5.10.0@a5effd2d2dddd1a7ea7a0f6a051ce63ff979e356">
+<files psalm-version="5.13.1@086b94371304750d1c673315321a55d15fc59015">
   <file src="src/DebugInclude.php">
     <PossiblyNullArrayOffset>
       <code><![CDATA[$this->_composerPaths]]></code>
@@ -40,6 +40,14 @@
       <code>new $class($this, $config)</code>
     </UnsafeInstantiation>
   </file>
+  <file src="src/Panel/PluginsPanel.php">
+    <InternalClass>
+      <code>PluginConfig::getAppConfig()</code>
+    </InternalClass>
+    <InternalMethod>
+      <code>PluginConfig::getAppConfig()</code>
+    </InternalMethod>
+  </file>
   <file src="src/Panel/SqlLogPanel.php">
     <UndefinedInterfaceMethod>
       <code>genericInstances</code>

src/Panel/PluginsPanel.php

@@ -0,0 +1,62 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
+ * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
+ * @link          https://cakephp.org CakePHP(tm) Project
+ * @license       https://www.opensource.org/licenses/mit-license.php MIT License
+ */
+namespace DebugKit\Panel;
+
+use Cake\Core\Plugin;
+use Cake\Core\PluginConfig;
+use DebugKit\DebugPanel;
+
+/**
+ * Provides debug information on the available plugins.
+ */
+class PluginsPanel extends DebugPanel
+{
+    /**
+     * @inheritDoc
+     */
+    public function initialize(): void
+    {
+        $loadedPluginsCollection = Plugin::getCollection();
+        $config = PluginConfig::getAppConfig();
+
+        $this->_data['hasEmptyAppConfig'] = empty($config);
+        $plugins = [];
+
+        foreach ($config as $pluginName => $options) {
+            $plugins[$pluginName] = [
+                'isLoaded' => $loadedPluginsCollection->has($pluginName),
+                'onlyDebug' => $options['onlyDebug'] ?? false,
+                'onlyCli' => $options['onlyCli'] ?? false,
+                'optional' => $options['optional'] ?? false,
+            ];
+        }
+
+        $this->_data['plugins'] = $plugins;
+    }
+
+    /**
+     * Get summary data for the plugins panel.
+     *
+     * @return string
+     */
+    public function summary(): string
+    {
+        if (!isset($this->_data['plugins'])) {
+            return '0';
+        }
+
+        return (string)count($this->_data['plugins']);
+    }
+}

src/ToolbarService.php

@@ -68,6 +68,7 @@ class ToolbarService
             'DebugKit.Packages' => true,
             'DebugKit.Mail' => true,
             'DebugKit.Deprecations' => true,
+            'DebugKit.Plugins' => true,
         ],
         'forceEnable' => false,
         'safeTld' => [],

templates/element/plugins_panel.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
+ * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
+ * @link          https://cakephp.org CakePHP(tm) Project
+ * @since         DebugKit 0.1
+ * @license       https://www.opensource.org/licenses/mit-license.php MIT License
+ */
+/**
+ * @var \DebugKit\View\AjaxView $this
+ * @var bool $hasEmptyAppConfig
+ * @var array $plugins
+ */
+?>
+<div class="c-plugins-panel">
+    <?php
+    $msg = 'This table shows all available plugins and your plugin configuration in';
+    $msg .= ' <strong>config/plugins.php</strong><br>';
+    printf('<p class="c-flash c-flash--info">%s</p>', $msg);
+    ?>
+    <section>
+        <table class="c-debug-table">
+            <thead>
+            <tr>
+                <th><?= __d('debug_kit', 'Plugin') ?></th>
+                <th><?= __d('debug_kit', 'Is Loaded') ?></th>
+                <th><?= __d('debug_kit', 'Only Debug') ?></th>
+                <th><?= __d('debug_kit', 'Only CLI') ?></th>
+                <th><?= __d('debug_kit', 'Optional') ?></th>
+            </tr>
+            </thead>
+            <tbody>
+            <?php foreach ($plugins as $pluginName => $pluginConfig) : ?>
+                <tr>
+                    <td><?= $pluginName ?></td>
+                    <td><?= $pluginConfig['isLoaded'] ? $this->Html->image('DebugKit./img/cake-red.svg') : '' ?></td>
+                    <td><?= $pluginConfig['onlyDebug'] ? $this->Html->image('DebugKit./img/cake-red.svg') : '' ?></td>
+                    <td><?= $pluginConfig['onlyCli'] ? $this->Html->image('DebugKit./img/cake-red.svg') : '' ?></td>
+                    <td><?= $pluginConfig['optional'] ? $this->Html->image('DebugKit./img/cake-red.svg') : '' ?></td>
+                </tr>
+            <?php endforeach; ?>
+            </tbody>
+        </table>
+    </section>
+</div>

tests/TestCase/Middleware/DebugKitMiddlewareTest.php

@@ -121,10 +121,10 @@ public function testInvokeSaveData()
         $this->assertSame(200, $result->status_code);
         $this->assertGreaterThan(1, $result->panels);
 
-        $this->assertSame('SqlLog', $result->panels[11]->panel);
-        $this->assertSame('DebugKit.sql_log_panel', $result->panels[11]->element);
-        $this->assertNotNull($result->panels[11]->summary);
-        $this->assertSame('Sql Log', $result->panels[11]->title);
+        $this->assertSame('SqlLog', $result->panels[12]->panel);
+        $this->assertSame('DebugKit.sql_log_panel', $result->panels[12]->element);
+        $this->assertNotNull($result->panels[12]->summary);
+        $this->assertSame('Sql Log', $result->panels[12]->title);
 
         $timeStamp = filectime(Plugin::path('DebugKit') . 'webroot' . DS . 'js' . DS . 'main.js');
 

tests/TestCase/ToolbarServiceTest.php

@@ -250,10 +250,10 @@ public function testSaveData()
         $this->assertSame(200, $result->status_code);
         $this->assertGreaterThan(1, $result->panels);
 
-        $this->assertSame('SqlLog', $result->panels[11]->panel);
-        $this->assertSame('DebugKit.sql_log_panel', $result->panels[11]->element);
-        $this->assertSame('0', $result->panels[11]->summary);
-        $this->assertSame('Sql Log', $result->panels[11]->title);
+        $this->assertSame('SqlLog', $result->panels[12]->panel);
+        $this->assertSame('DebugKit.sql_log_panel', $result->panels[12]->element);
+        $this->assertSame('0', $result->panels[12]->summary);
+        $this->assertSame('Sql Log', $result->panels[12]->title);
     }
 
     /**

webroot/css/style.css

@@ -676,6 +676,10 @@ strong {
     border-left: 1px solid var(--mail-border);
 }
 
+.c-plugins-panel img {
+    height: 18px;
+}
+
 .u-text-center {
     text-align: center;
 }