Fire an event when user uses magic login link

Author: lonnieezell

docs/quickstart.md

@@ -14,6 +14,8 @@ NOTE: The examples assume that you have run the setup script and that you have c
     - [Enable Account Activation via Email](#enable-account-activation-via-email)
     - [Enable Two-Factor Authentication](#enable-two-factor-authentication)
     - [Responding to Magic Link Logins](#responding-to-magic-link-logins)
+      - [Session Notification](#session-notification)
+      - [Event](#event)
   - [Authorization Flow](#authorization-flow)
     - [Change Available Groups](#change-available-groups)
     - [Set the Default Group](#set-the-default-group)
@@ -131,10 +133,12 @@ public array $actions = [
 
 Magic Link logins allow a user that has forgotten their password that have an email sent with a unique login link that will provide a one-time login for them. Once they've logged in you can decide how to respond. In some cases, you might want to redirect them to a special page where the must choose a new password. In other cases, you might simply want to display a one-time message prompting them to go to their account page and choose a new password there.
 
+#### Session Notification
+
 You can detect if a user has finished the magic link login by checking for a session value, `magic_link_login`. If they have recently completed the flow, it will exist and have a value of `true`.
 
 ```php
-if (session('magic_link_login')) {
+if (session('magic_login')) {
     return redirect()->route('set_password');
 }
 ```
@@ -145,6 +149,17 @@ This value sticks around in the session for 5 minutes. Once you no longer need t
 session()->removeTempData('magic_link_login');
 ```
 
+#### Event
+
+At the same time the above session variable is set, a `magic_login` [event](https://codeigniter.com/user_guide/extending/events.html) is fired off that you may subscribe to. Note that no data is passed to the event as you can easily grab the current user from the `user()` helper or the `auth()->user()` method.
+
+```php
+Events::on('magic_login', static function () {
+    // ...
+});
+```
+
+
 ## Authorization Flow
 
 ### Change Available Groups

src/Controllers/MagicLinkController.php

@@ -165,7 +165,9 @@ public function verify(): RedirectResponse
 
         // Give the developer a way to know the user
         // logged in via a magic link.
-        session()->setTempdata('magic_link_login', true);
+        session()->setTempdata('magic_login', true);
+
+        Events::trigger('magic_login');
 
         // Get our login redirect url
         return redirect()->to(config('Auth')->loginRedirect());

tests/Authentication/MagicLinkTest.php

@@ -139,7 +139,7 @@ public function testMagicLinkVerifySuccess(): void
         $this->assertTrue(auth()->loggedIn());
 
         // It should have set temp session var
-        $this->assertTrue(session()->has('magic_link_login'));
-        $this->assertTrue(session('magic_link_login'));
+        $this->assertTrue(session()->has('magic_login'));
+        $this->assertTrue(session('magic_login'));
     }
 }