Laravel Magic Login

To enable the magic link functionality, you must register the magic link route in your application's routing files. It is recommended to add this to routes/web.php using the MagicLink facade.

use Maize\
MagicLogin\\Facades\\MagicLink;

MagicLink::route();

To add passwordless authentication to your Laravel application, install the package via Composer and then run the installation command to publish configuration and migration files.

composer require maize-tech/laravel-magic-login

php artisan magic-login:install

To change the appearance or content of the magic link email, create a custom notification class that extends Maize\MagicLogin\Notifications\MagicLinkNotification. You can then update the notification key in config/magic-login.php to point to your new class.

Note: The base class provides the $this->uri property which contains the magic link.

use Illuminate\
Notifications\\Messages\\MailMessage;
use Maize\\MagicLogin\\Notifications\\MagicLinkNotification as BaseMagicLinkNotification;

class MagicLinkNotification extends BaseMagicLinkNotification
{
    public function toMail($notifiable): MailMessage
    {
        return (new MailMessage)
            ->line(__('This is my custom magic link notification message'))
            ->action(__('Join now'), $this->uri);
    }
}

You can attach custom metadata to a magic link using the metadata parameter. This data is stored in the database and can be queried using the Maize\MagicLogin\Models\MagicLogin model via JSON queries.

use App\\Models\\User;
use Maize\\MagicLogin\\Facades\\MagicLink;
use Maize\\MagicLogin\\Models\\MagicLogin;

$user = User::firstOrFail();

// Attach metadata
$magicLink = MagicLink::send(
    authenticatable: $user,
    metadata: ['test' => true]
);

// Query using metadata
MagicLogin::query()
    ->whereJsonContains('metadata->test', true)
    ->count(); // returns 1

To generate a link and automatically send it to the user via email, use the send method. Alternatively, you can use make with the notify: true parameter.

// Option 1: Using send()
use App\\Models\\User;
use Maize\\MagicLogin\\Facades\\MagicLink;

$user = User::firstOrFail();
$magicLink = MagicLink::send(
    authenticatable: $user
);

// Option 2: Using make() with notify: true
$magicLink = MagicLink::make(
    authenticatable: $user,
    notify: true
);

You can generate a magic link for any model that extends Laravel's Authenticatable class using the make method. This returns the link without sending any notifications.

use App\\Models\\User;
use Maize\\MagicLogin\\Facades\\MagicLink;

$user = User::firstOrFail();

$magicLink = MagicLink::make(
    authenticatable: $user
);

The make and send methods accept several parameters to customize the behavior of the generated link:

• redirectUrl: The URL the user is sent to after successful authentication. Defaults to the redirect_url config value.
• expiration: How long the link remains valid. Accepts a Carbon instance or an integer representing minutes. Defaults to the expiration config value.
• routeName: The name of the route used to generate the link. Defaults to route.name in config.
• guard: The authentication guard to use (e.g., 'api'). Defaults to the guard config value.
• loginsLimit: How many times the link can be used. Use -1 for infinite uses. Defaults to logins_limit in config.
• metadata: An associative array of custom data to store with the link for later querying.

The MagicLogin model provides a login() method that authenticates the associated user (the authenticatable entity) using the guard specified in the record.

When calling login():

1. It verifies if the associated entity exists and if the logins_limit has been reached.
2. It uses the guard attribute to determine which Laravel authentication guard to use.
3. It performs the login via auth()->guard($this->guard)->login($this->authenticatable).
4. It increments the logins counter.

If the entity is missing or the login limit has been exceeded, an Exception is thrown.

// Assuming you have retrieved a MagicLogin instance
$magicLogin = MagicLogin::where('uuid', $uuid)->first();

try {
    $magicLogin->login();
} catch (\Exception $e) {
    // Handle failed login (e.g., expired, limit reached, or user not found)
}