Add forgetUser() method to GuardHelpers

laravel · Dec 7, 2022 · 73685ff · 73685ff
1 parent cad86c1
commit 73685ff
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 0 deletions.
diff --git a/src/Illuminate/Auth/GuardHelpers.php b/src/Illuminate/Auth/GuardHelpers.php
@@ -95,6 +95,16 @@ public function setUser(AuthenticatableContract $user)
         return $this;
     }
 
+    /**
+     * Forget the user.
+     *
+     * @return void
+     */
+    public function forgetUser()
+    {
+        $this->user = null;
+    }
+
     /**
      * Get the user provider used by the guard.
      *

diff --git a/src/Illuminate/Support/Facades/Auth.php b/src/Illuminate/Support/Facades/Auth.php
@@ -56,6 +56,7 @@
  * @method static \Illuminate\Auth\SessionGuard setRequest(\Symfony\Component\HttpFoundation\Request $request)
  * @method static \Illuminate\Support\Timebox getTimebox()
  * @method static \Illuminate\Contracts\Auth\Authenticatable authenticate()
+ * @method static void forgetUser()
  * @method static \Illuminate\Contracts\Auth\UserProvider getProvider()
  * @method static void setProvider(\Illuminate\Contracts\Auth\UserProvider $provider)
  * @method static void macro(string $name, object|callable $macro)

diff --git a/tests/Auth/AuthGuardTest.php b/tests/Auth/AuthGuardTest.php
@@ -588,6 +588,14 @@ public function testLoginOnceFailure()
         $this->assertFalse($guard->once(['foo']));
     }
 
+    public function testForgetUserSetsUserToNull()
+    {
+        $user = m::mock(Authenticatable::class);
+        $guard = $this->getGuard()->setUser($user);
+        $guard->forgetUser();
+        $this->assertNull($guard->getUser());
+    }
+
     protected function getGuard()
     {
         [$session, $provider, $request, $cookie, $timebox] = $this->getMocks();