Make auth tab optional and show only user name (#1578)

* Make auth tab optional and show only user name * Update LaravelDebugbar.php * Add config --------- Co-authored-by: Barry vd. Heuvel <[email protected]>
barryvdh · Apr 1, 2024 · 8916325 · 8916325
1 parent 1a27ae0
commit 8916325
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 5 deletions.
diff --git a/config/debugbar.php b/config/debugbar.php
@@ -208,6 +208,7 @@
         ],
         'auth' => [
             'show_name' => true,   // Also show the users name/email in the debugbar
+            'show_guards' => true, // Show the guards that are used
         ],
         'db' => [
             'with_params'       => true,   // Render SQL with the parameters substituted

diff --git a/src/DataCollector/MultiAuthCollector.php b/src/DataCollector/MultiAuthCollector.php
@@ -25,6 +25,9 @@ class MultiAuthCollector extends DataCollector implements Renderable
     /** @var bool */
     protected $showName = false;
 
+    /** @var bool */
+    protected $showGuardsData = true;
+
     /**
      * @param \Illuminate\Auth\AuthManager $auth
      * @param array $guards
@@ -44,6 +47,15 @@ public function setShowName($showName)
         $this->showName = (bool) $showName;
     }
 
+    /**
+     * Set to hide the guards tab, and show only name
+     * @param bool $showGuardsData
+     */
+    public function setShowGuardsData($showGuardsData)
+    {
+        $this->showGuardsData = (bool) $showGuardsData;
+    }
+
     /**
      * @{inheritDoc}
      */
@@ -79,6 +91,9 @@ public function collect()
         }
 
         $data['names'] = rtrim($names, ', ');
+        if (!$this->showGuardsData) {
+            unset($data['guards']);
+        }
 
         return $data;
     }
@@ -142,14 +157,16 @@ public function getName()
      */
     public function getWidgets()
     {
-        $widgets = [
-            "auth" => [
+        $widgets = [];
+
+        if ($this->showGuardsData) {
+            $widgets["auth"] = [
                 "icon" => "lock",
                 "widget" => "PhpDebugBar.Widgets.VariableListWidget",
                 "map" => "auth.guards",
-                "default" => "{}"
-            ]
-        ];
+                "default" => "{}",
+            ];
+        }
 
         if ($this->showName) {
             $widgets['auth.name'] = [

diff --git a/src/LaravelDebugbar.php b/src/LaravelDebugbar.php
@@ -492,6 +492,9 @@ public function __toString(): string
                 $this['auth']->setShowName(
                     $config->get('debugbar.options.auth.show_name')
                 );
+                $this['auth']->setShowGuardsData(
+                    $config->get('debugbar.options.auth.show_guards', true)
+                );
             } catch (Exception $e) {
                 $this->addCollectorException('Cannot add AuthCollector', $e);
             }