Filament OTP Login

https://github.com/afsakar/filament-otp-login
Admin
Filament OTP Login is an OTP (one-time password) authentication package for FilamentPHP that allows...
Tokens:28,426
Snippets:441
Trust Score:8.5
License:MIT
Update:3 months ago
Show doc for...
Tokens:
Raw
### GetStep Usage Example

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/Login.md

Example showing how to check the current authentication step.

```php
if ($loginPage->getStep() === 2) {
    // OTP input is visible
}
```

--------------------------------

### Package Installation Commands

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/FilamentOtpLoginServiceProvider.md

Commands used to install the package and set up necessary assets.

```bash
php artisan vendor:install
```

```bash
php artisan filament-otp-login:install
```

--------------------------------

### Mount Method Implementation

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/Login.md

Example implementation of the mount method.

```php
public function mount(): void
{
    parent::mount();
    // Login page is automatically mounted by Livewire
}
```

--------------------------------

### Registering the plugin with minimal setup

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/module-exports.md

Add the plugin to the panel provider to enable basic OTP functionality.

```php
use Afsakar\FilamentOtpLogin\FilamentOtpLoginPlugin;

// In panel provider
$panel->plugins([
    FilamentOtpLoginPlugin::make()
]);
```

--------------------------------

### Initialize OtpCode

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/OtpCode.md

Example of instantiating the model where the table name is automatically resolved from configuration.

```php
$otpCode = new OtpCode();
// Table name automatically set to configured value
```

--------------------------------

### Command Output Example

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/PruneOtpCodes.md

Expected console output after running the prune command.

```text
Pruning expired OTP codes...
Pruned 147 expired OTP codes.
```

```text
Pruning expired OTP codes...
Pruned 42 expired OTP codes.
```

--------------------------------

### Configure Table Name

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/database-schema.md

Example of setting the table name in the plugin configuration.

```php
// Configuration says 'otp_codes' but table is 'custom_otp_codes'
FilamentOtpLoginPlugin::make()
    ->tableName('otp_codes')
```

--------------------------------

### Form Component Initialization

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/types.md

Examples of initializing Filament form components for the login page.

```php
OneTimeCodeInput::make('otp')
```

```php
TextInput::make('email')
```

--------------------------------

### Configure Notification Queueing

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/SendOtpCode.md

Examples for setting queue properties within the notification class or defining the default queue connection in the configuration file.

```php
// In your notification
public function __construct(public string $code, public int $expiresIn)
{
    $this->queue = 'high-priority';
    $this->delay = now()->addSeconds(5);
}
```

```php
// config/queue.php
'default' => env('QUEUE_CONNECTION', 'sync'),
```

--------------------------------

### Authenticate Usage Example

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/Login.md

Shows the automatic invocation of the authenticate method.

```php
// Called automatically when user clicks authenticate button
// return $loginPage->authenticate();
```

--------------------------------

### Send OTP Usage Example

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/Login.md

Shows the automatic invocation of the sendOtp method.

```php
// Called automatically when user submits identifier form
// $loginPage->sendOtp();
```

--------------------------------

### Install Package via Composer

Source: https://github.com/afsakar/filament-otp-login/blob/v2/README.md

Run this command in your terminal to add the package to your project.

```bash
composer require afsakar/filament-otp-login
```

--------------------------------

### Constructing MailMessage for OTP

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/types.md

Example of building a notification email message for sending OTP codes.

```php
(new MailMessage)
    ->subject('Your OTP Code')
    ->greeting('Hello!')
    ->line('Your code is: 123456')
```

--------------------------------

### Implement canLoginDirectly Logic

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/CanLoginDirectly.md

Examples of implementing the bypass logic within a user model.

```php
public function canLoginDirectly(): bool
{
    // Admin users can login directly
    return $this->role === 'admin';
}
```

```php
<?php

namespace App\Models;

use Afsakar\FilamentOtpLogin\Models\Contracts\CanLoginDirectly;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable implements CanLoginDirectly
{
    public function canLoginDirectly(): bool
    {
        // Allow direct login for admin users
        return $this->role === 'admin';
    }
}
```

```php
public function canLoginDirectly(): bool
{
    return $this->hasRole(['admin', 'super-admin']);
}
```

```php
public function canLoginDirectly(): bool
{
    // Allow direct login for company email addresses
    return str($this->email)->endsWith('@example.com');
}
```

```php
public function canLoginDirectly(): bool
{
    return $this->role === 'admin' 
        && $this->email_verified_at !== null 
        && $this->two_factor_enabled === false;
}
```

--------------------------------

### Resend Code Usage Example

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/Login.md

Shows the Livewire dispatch for triggering the resendCode method.

```php
// Livewire dispatch in view:
// wire:click="dispatch('resendCode')"
```

--------------------------------

### Retrieve Plugin Instance via get()

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/FilamentOtpLoginPlugin.md

Fetches the currently registered plugin instance for the active Filament panel. May throw an exception if the plugin is not registered.

```php
$plugin = FilamentOtpLoginPlugin::get();
$otpLength = $plugin->getOtpCodeLength();
```

--------------------------------

### Get Plugin Instance

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/Login.md

Accesses the active plugin instance to retrieve configuration settings.

```php
protected function plugin(): FilamentOtpLoginPlugin
```

```php
$length = $loginPage->plugin()->getOtpCodeLength();
```

--------------------------------

### Custom Notification Implementation

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/SendOtpCode.md

A complete example of a custom notification class and its registration within the Filament plugin configuration.

```php
<?php

namespace App\Notifications;

use Illuminate\Bus\Queueable;
use Illuminate\Notifications\Messages\MailMessage;
use Illuminate\Notifications\Notification;

class OtpCodeNotification extends Notification
{
    use Queueable;

    public function __construct(public string $code, public int $expiresIn)
    {
        $this->queue = 'emails';
    }

    public function via($notifiable)
    {
        return ['mail'];
    }

    public function toMail($notifiable)
    {
        return (new MailMessage)
            ->view('emails.otp-code', [
                'code' => $this->code,
                'expiresIn' => $this->expiresIn,
                'recipient' => $notifiable,
            ]);
    }
}
```

```php
FilamentOtpLoginPlugin::make()
    ->notification(\App\Notifications\OtpCodeNotification::class)
```

--------------------------------

### Initialize Plugin and Extend Classes

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/module-exports.md

Demonstrates plugin configuration, custom notification and login page overrides, and implementing the user model interface.

```php
// Plugin initialization (in panel provider)
use Afsakar\FilamentOtpLogin\FilamentOtpLoginPlugin;

$plugin = FilamentOtpLoginPlugin::make()
    ->otpCode(length: 6, expiresIn: 300)
    ->rateLimit(attempts: 5, decaySeconds: 60)
    // ... etc

// Custom notification
use Afsakar\FilamentOtpLogin\Notifications\SendOtpCode;

class CustomOtpNotification extends SendOtpCode {
    // Override methods
}

// Custom login page
use Afsakar\FilamentOtpLogin\Filament\Pages\Login;

class CustomLogin extends Login {
    // Override methods
}

// User model interface
use Afsakar\FilamentOtpLogin\Models\Contracts\CanLoginDirectly;

class User extends Authenticatable implements CanLoginDirectly {
    public function canLoginDirectly(): bool {
        // Implementation
    }
}

// Artisan command
php artisan otp-codes:prune
```

--------------------------------

### Publish Migrations and Run

Source: https://github.com/afsakar/filament-otp-login/blob/v2/README.md

Publish the package migrations and apply them to your database.

```bash
php artisan vendor:publish --tag="filament-otp-login-migrations"
php artisan migrate
```

--------------------------------

### Configure the plugin

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/FilamentOtpLoginPlugin.md

Demonstrates full configuration including OTP settings, identifier fields, rate limiting, and custom model or notification overrides.

```php
use Afsakar\FilamentOtpLogin\FilamentOtpLoginPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            FilamentOtpLoginPlugin::make()
                // OTP settings
                ->otpCode(length: 6, expiresIn: 300)
                
                // Identifier configuration
                ->identifierFormField('email', label: 'Email Address', type: 'email')
                ->userIdentifierColumn('email')
                ->identifierColumn('identifier')
                
                // Rate limiting
                ->rateLimit(attempts: 5, decaySeconds: 60)
                ->resendLimit(attempts: 3, decaySeconds: 300)
                
                // Advanced options
                ->userModel('App\\Models\\User')
                ->tableName('otp_codes')
                ->passwordless(false)
                ->notification(\App\Notifications\SendOtpCode::class)
                ->loginPage(\App\Filament\Pages\CustomLogin::class)
        ]);
}
```

--------------------------------

### Boot the plugin

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/FilamentOtpLoginPlugin.md

Lifecycle method called after plugin registration, currently performing no operations.

```php
public function boot(Panel $panel): void
```

--------------------------------

### Project File Manifest

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/MANIFEST.md

A list of all documentation files and their respective sizes in kilobytes.

```text
README.md ................................. 9.9 KB
INDEX.md ................................. 13 KB
configuration.md ......................... 13 KB
database-schema.md ....................... 7.9 KB
module-exports.md ........................ 8.8 KB
types.md ................................. 5.8 KB
api-reference/
  FilamentOtpLoginPlugin.md ............. 14 KB
  Login.md .............................. 16 KB
  OtpCode.md ............................ 6.6 KB
  SendOtpCode.md ........................ 8.6 KB
  CanLoginDirectly.md ................... 7.6 KB
  PruneOtpCodes.md ...................... 7.7 KB
  FilamentOtpLoginServiceProvider.md ... 8.7 KB

Total: ~145 KB
```

--------------------------------

### Instantiate Plugin via make()

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/FilamentOtpLoginPlugin.md

Creates a new instance of the plugin from the service container.

```php
$plugin = FilamentOtpLoginPlugin::make();
```

--------------------------------

### Complete login flow process

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/Login.md

Outlines the sequence of steps from OTP generation to user authentication.

```php
// Step 1: User enters email and password (or email only in passwordless mode)
// Form submits to sendOtp()

// Step 2: OTP is generated and sent
$loginPage->generateCode();
$loginPage->sendOtpToUser($otp);

// Step 3: User enters OTP code
// Form submits to authenticate()

// Step 4: OTP is verified
$loginPage->verifyCode();

// Step 5: User is logged in
$loginPage->doLogin();
```

--------------------------------

### Get Identifier

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/Login.md

Retrieves the identifier value, such as an email or phone number, from the form data.

```php
protected function identifier(): string
```

```php
$email = $loginPage->identifier(); // 'user@example.com'
```

--------------------------------

### Run Migrations

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/database-schema.md

Command to execute pending database migrations.

```bash
php artisan migrate
```

--------------------------------

### Pruning OtpCode Records

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/types.md

Example of using the Eloquent query builder to prune expired OTP codes.

```php
OtpCode::where('expires_at', '<=', now()->subDay()->startOfDay())
```

--------------------------------

### Type Form Data Array

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/types.md

Type definition and example structure for form data used during the login process.

```php
array<string, mixed>
```

```php
[
    'email' => 'user@example.com',
    'password' => 'secret',
    'otp' => '123456',
    'remember' => true
]
```

--------------------------------

### Register Migrations

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/FilamentOtpLoginServiceProvider.md

Returns the list of migration files and provides the commands for publishing and running them.

```php
protected function getMigrations(): array
{
    return [
        'create_filament_otp_login_table',
        'rename_filament_otp_login_email_column',
    ];
}
```

```bash
php artisan vendor:publish --tag="filament-otp-login-migrations"
php artisan migrate
```

--------------------------------

### Boot package hook

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/FilamentOtpLoginServiceProvider.md

Lifecycle method triggered after the package and all services are fully booted.

```php
public function packageBooted(): void
{
    //
}
```

--------------------------------

### Construct OtpCode Instance

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/OtpCode.md

Constructor signature for initializing the model with attributes.

```php
public function __construct(array $attributes = [])
```

--------------------------------

### Configure package resources

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/FilamentOtpLoginServiceProvider.md

Method signature for configuring package resources, commands, and publishing paths.

```php
public function configurePackage(Package $package): void
```

--------------------------------

### Publish Views

Source: https://github.com/afsakar/filament-otp-login/blob/v2/README.md

Optionally publish the package views for customization.

```bash
php artisan vendor:publish --tag="filament-otp-login-views"
```

--------------------------------

### Constructor Initialization

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/SendOtpCode.md

Initializes the notification with the OTP code and expiration time.

```php
public function __construct(public string $code, public int $expiresIn = 120)
{
    //
}
```

```php
use Afsakar\FilamentOtpLogin\Notifications\SendOtpCode;

$notification = new SendOtpCode('123456', 300);
// $notification->code === '123456'
// $notification->expiresIn === 300
```

--------------------------------

### Authentication Flow Steps

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/INDEX.md

Outlines the sequence of operations for different login strategies.

```text
1. User enters identifier (email) and password
2. sendOtp() validates credentials
3. OTP code is generated and hashed
4. OTP is sent via notification
5. Page advances to step 2 (OTP input)
6. User enters OTP
7. authenticate() verifies OTP
8. User is logged in
```

```text
1. User enters identifier (email/phone only)
2. sendOtp() validates user exists
3. OTP code is generated and hashed
4. OTP is sent via notification
5. Page advances to step 2 (OTP input)
6. User enters OTP
7. authenticate() verifies OTP
8. User is logged in (no password needed)
```

```text
1. User enters identifier and password
2. sendOtp() validates credentials
3. User is loaded from database
4. canLoginDirectly() returns true
5. User is logged in immediately (no OTP)
6. No notification is sent
```

--------------------------------

### Configure OTP via Environment Variables

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/configuration.md

Use Laravel's config helper to map environment variables to plugin configuration methods.

```php
FilamentOtpLoginPlugin::make()
    ->otpCode(
        length: (int) config('otp.length', 6),
        expiresIn: (int) config('otp.expires_in', 300)
    )
    ->rateLimit(
        attempts: (int) config('otp.rate_limit.attempts', 5),
        decaySeconds: (int) config('otp.rate_limit.decay', 60)
    )
    ->passwordless((bool) config('otp.passwordless', false))
```

```php
return [
    'length' => env('OTP_LENGTH', 6),
    'expires_in' => env('OTP_EXPIRES_IN', 300),
    'rate_limit' => [
        'attempts' => env('OTP_RATE_LIMIT_ATTEMPTS', 5),
        'decay' => env('OTP_RATE_LIMIT_DECAY', 60),
    ],
    'passwordless' => env('OTP_PASSWORDLESS', false),
];
```

--------------------------------

### FilamentOtpLoginPlugin::make()

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/module-exports.md

Initializes the plugin configuration within your Filament panel provider.

```APIDOC
## FilamentOtpLoginPlugin::make()

### Description
Configures the OTP login plugin settings such as code length, expiration time, and rate limiting.

### Usage
```php
use Afsakar\FilamentOtpLogin\FilamentOtpLoginPlugin;

$plugin = FilamentOtpLoginPlugin::make()
    ->otpCode(length: 6, expiresIn: 300)
    ->rateLimit(attempts: 5, decaySeconds: 60);
```
```

--------------------------------

### Run project tests

Source: https://github.com/afsakar/filament-otp-login/blob/v2/README.md

Executes the test suite using Composer.

```bash
composer test
```

--------------------------------

### Mount Method Definition

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/Login.md

Method signature for initializing the login page.

```php
public function mount(): void
```

--------------------------------

### Configuring the plugin with custom settings

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/module-exports.md

Customize OTP length, rate limits, notification classes, and login pages via the plugin builder.

```php
use Afsakar\FilamentOtpLogin\FilamentOtpLoginPlugin;
use App\Filament\Pages\CustomLogin;
use App\Notifications\CustomOtpNotification;

// In panel provider
$panel->plugins([
    FilamentOtpLoginPlugin::make()
        ->otpCode(length: 6, expiresIn: 300)
        ->identifierFormField('email', 'Email', 'email')
        ->userIdentifierColumn('email')
        ->rateLimit(attempts: 5, decaySeconds: 60)
        ->resendLimit(attempts: 3, decaySeconds: 300)
        ->passwordless(false)
        ->notification(CustomOtpNotification::class)
        ->loginPage(CustomLogin::class)
]);
```

--------------------------------

### Validate Credentials and Initiate OTP

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/Login.md

Handles the authentication logic, including OTP generation or direct login based on the configured mode.

```php
protected function checkCredentials($data): void
```

--------------------------------

### Command Configuration Properties

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/PruneOtpCodes.md

Configuration properties defining the command signature and description.

```php
protected $signature = 'otp-codes:prune';
```

```php
protected $description = 'Prune expired OTP codes.';
```

--------------------------------

### Publish Package Assets

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/FilamentOtpLoginServiceProvider.md

Commands to publish package assets, configurations, migrations, translations, or views to the application.

```bash
php artisan vendor:publish --provider="Afsakar\FilamentOtpLogin\FilamentOtpLoginServiceProvider"
```

```bash
php artisan vendor:publish --tag="filament-otp-login-config"
```

```bash
php artisan vendor:publish --tag="filament-otp-login-migrations"
```

```bash
php artisan vendor:publish --tag="filament-otp-login-translations"
```

```bash
php artisan vendor:publish --tag="filament-otp-login-views"
```

--------------------------------

### Publish Configuration Files

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/FilamentOtpLoginServiceProvider.md

Publishes the package configuration file to the application's config directory.

```bash
php artisan vendor:publish --tag="filament-otp-login-config"
```

--------------------------------

### Configure FilamentOtpLoginPlugin

Source: https://github.com/afsakar/filament-otp-login/blob/v2/README.md

Define OTP settings per panel using the plugin configuration method.

```php
FilamentOtpLoginPlugin::make()
    ->otpCode(length: 6, expiresIn: 120)
    ->rateLimit(attempts: 5, decaySeconds: 60)
    ->resendLimit(attempts: 3, decaySeconds: 300)
    ->passwordless(false)
    ->notification(\Afsakar\FilamentOtpLogin\Notifications\SendOtpCode::class);
```

--------------------------------

### OTP Record Lifecycle

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/database-schema.md

Illustrates the generation, hashing, storage, and verification process for OTP records.

```text
1. User initiates login
2. OTP code generated (e.g., '123456')
3. Code hashed: Hash::make('123456')
4. Record created:
   {
     id: 1,
     code: '$2y$12$...',
     identifier: 'user@example.com',
     expires_at: '2024-01-15 14:30:45',
     created_at: '2024-01-15 14:25:45',
     updated_at: '2024-01-15 14:25:45'
   }
5. User enters code
6. Code verified: Hash::check('123456', stored_hash)
7. Record deleted
```

--------------------------------

### Define Login Form Step

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/Login.md

Method signature for the first step of the login form.

```php
public function form(Schema $schema): Schema
```

--------------------------------

### Handle Table Not Found Error

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/database-schema.md

Indicates the database table is missing or was not migrated.

```sql
SQLSTATE[42S02]: Table not found
```

--------------------------------

### Execute and Monitor Pruning via CLI

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/PruneOtpCodes.md

Run the pruning command and verify the results using SQL queries to check table size and record expiration.

```bash
# Run the command
php artisan otp-codes:prune

# Check table size
mysql -u user -p database_name -e "SELECT COUNT(*) FROM otp_codes;"

# Check oldest record
mysql -u user -p database_name -e "SELECT MIN(expires_at) FROM otp_codes;"
```

--------------------------------

### Publish Translation Files

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/SendOtpCode.md

Use this command to publish the package translation files to your local resources directory for customization.

```bash
php artisan vendor:publish --tag="filament-otp-login-translations"
```

--------------------------------

### Publish Database Migrations

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/FilamentOtpLoginServiceProvider.md

Publishes the necessary database migration files to the application's database/migrations directory.

```bash
php artisan vendor:publish --tag="filament-otp-login-migrations"
```

--------------------------------

### Project Directory Structure

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/MANIFEST.md

Visual representation of the project file hierarchy.

```text
/workspace/home/output/
├── README.md                          - Start here for overview
├── INDEX.md                          - Master quick reference
├── configuration.md                  - All config options
├── database-schema.md               - Database structure
├── types.md                         - Type definitions
├── module-exports.md                - Export manifest
├── MANIFEST.md                      - This file
├── COMPLETION_SUMMARY.txt           - Generation report
└── api-reference/                   - 7 class/module docs
    ├── FilamentOtpLoginPlugin.md
    ├── Login.md
    ├── OtpCode.md
    ├── SendOtpCode.md
    ├── CanLoginDirectly.md
    ├── PruneOtpCodes.md
    └── FilamentOtpLoginServiceProvider.md
```

--------------------------------

### Configure FilamentOtpLoginPlugin

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/INDEX.md

Chainable configuration methods for the main plugin instance.

```php
// Configuration (chainable)
->otpCode(length: 6, expiresIn: 120)
->rateLimit(attempts: 5, decaySeconds: 60)
->resendLimit(attempts: 3, decaySeconds: 300)
->identifierFormField('email', 'Email', 'email')
->userIdentifierColumn('email')
->passwordless(false)
->notification(\Notification\Class::class)
->loginPage(\LoginPage\Class::class)

// Factories
static make()
static get()
```

--------------------------------

### Configure Multi-Panel OTP Tables

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/database-schema.md

Assign unique table names to different Filament panels to isolate OTP data.

```php
// Panel 1: Admin
FilamentOtpLoginPlugin::make()
    ->tableName('admin_otp_codes')

// Panel 2: User Portal
FilamentOtpLoginPlugin::make()
    ->tableName('user_otp_codes')
```

--------------------------------

### Login Page Methods

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/INDEX.md

Key methods for managing the OTP authentication flow and form configuration.

```php
// Main flow
public function authenticate(): ?LoginResponse
public function sendOtp(): void
public function verifyCode(): void

// Code generation
public function generateCode(): void
public function resendCode(): void

// Navigation
public function goBack(): void

// Configuration
public function form(Schema $schema): Schema
public function otpForm(Schema $schema): Schema
```

--------------------------------

### Execute login process

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/Login.md

Handles the authentication flow, including passwordless login or credential verification, and session regeneration.

```php
protected function doLogin(): void
```

--------------------------------

### sendOtp()

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/Login.md

Initiates the OTP login flow by validating credentials and sending the code.

```APIDOC
## sendOtp()

### Description
Initiates the OTP login flow by validating identifier and password, then generating and sending the code.

### Signature
`public function sendOtp(): void`

### Throws
- **ValidationException** - If credentials are invalid
```

--------------------------------

### Configure static package properties

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/FilamentOtpLoginServiceProvider.md

Defines the package identifier and view namespace used for configuration and asset resolution.

```php
public static string $name = 'filament-otp-login';
public static string $viewNamespace = 'filament-otp-login';
```

--------------------------------

### Configure FilamentOtpLoginPlugin

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/README.md

Use this to initialize and configure the plugin settings within your Filament panel provider.

```php
FilamentOtpLoginPlugin::make()
    ->otpCode(length: 6, expiresIn: 300)
    ->identifierFormField('email', 'Email', 'email')
    ->rateLimit(attempts: 5, decaySeconds: 60)
    ->passwordless(false)
```

--------------------------------

### Clear and Rebuild Application Caches

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/FilamentOtpLoginServiceProvider.md

Use these commands during development to ensure configuration and package discovery caches are updated.

```bash
# Clear application cache
php artisan cache:clear

# Clear config cache
php artisan config:clear

# Rebuild command cache
php artisan package:discover
```

--------------------------------

### Configure SMS/WhatsApp Delivery

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/SendOtpCode.md

Implement channel-specific methods to route notifications via services like Vonage.

```php
public function via($notifiable)
{
    return ['vonage'];
}

public function toVonage($notifiable)
{
    return (new VonageMessage)
        ->content('Your OTP is: ' . $this->code);
}

public function routeNotificationForVonage($notification)
{
    // Use the identifier from the login page
    return $this->identifier;
}
```

--------------------------------

### Define Authentication Steps

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/types.md

Integer values representing the current stage of the authentication process.

```text
1 = Identifier/password entry (or identifier-only in passwordless)
2 = OTP entry
```

--------------------------------

### Configure passwordless login

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/FilamentOtpLoginPlugin.md

Toggles passwordless login mode, which requires only an OTP for authentication.

```php
public function passwordless(bool $condition = true): static
```

```php
FilamentOtpLoginPlugin::make()
    ->passwordless(true)
```

--------------------------------

### Define FilamentOtpLoginServiceProvider class

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/module-exports.md

Handles package registration and asset publishing, auto-loaded via Laravel package discovery.

```php
class FilamentOtpLoginServiceProvider extends PackageServiceProvider
```

--------------------------------

### authenticate()

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/Login.md

The main authentication action handler triggered upon submitting the login button. It verifies the OTP code and logs the user in.

```APIDOC
## authenticate()

### Description
Main authentication action handler (submitted with login button). It applies rate limiting, verifies the OTP code, logs the user in, and returns a redirect response.

### Signature
`public function authenticate(): ?LoginResponse`

### Returns
- **LoginResponse** - Response redirecting to the panel

### Throws
- **ValidationException** - If OTP is invalid or expired
```

--------------------------------

### Define OtpCode PHPDoc Annotations

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/OtpCode.md

Provides IDE support for model properties by documenting types.

```php
/**
 * @property string $code
 * @property string $identifier
 * @property Carbon $expires_at
 */
```

--------------------------------

### Registering the OTP Plugin

Source: https://github.com/afsakar/filament-otp-login/blob/v2/README.md

Register the plugin in your panel provider file to configure OTP length, expiration, and rate limits.

```php
use Afsakar\FilamentOtpLogin\FilamentOtpLoginPlugin;

    public function panel(Panel $panel): Panel
    {
        return $panel
            ->plugins([
                FilamentOtpLoginPlugin::make()
                    ->otpCode(length: 6, expiresIn: 120)
                    ->rateLimit(attempts: 5, decaySeconds: 60)
                    ->resendLimit(attempts: 3, decaySeconds: 300),
            ]);
    }
```

--------------------------------

### GetStep Method Definition

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/Login.md

Method signature for retrieving the current authentication step.

```php
public function getStep(): int
```

--------------------------------

### Enable Passwordless Mode

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/INDEX.md

Configures the plugin to allow authentication without a password.

```php
FilamentOtpLoginPlugin::make()
    ->passwordless(true)
```

--------------------------------

### Implement CanLoginDirectly Interface

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/README.md

Implement this interface on your User model to define logic for bypassing OTP authentication.

```php
class User implements CanLoginDirectly {
    public function canLoginDirectly(): bool {
        return $this->role === 'admin';
    }
}
```

--------------------------------

### Framework Integration Points

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/module-exports.md

Lists the core Filament and Laravel classes and interfaces used for framework integration.

```php
// Plugin registration
Filament\Contracts\Plugin

// Login page base
Filament\Auth\Pages\Login

// Form components
Filament\Schemas\Components\Component
Filament\Forms\Components\OneTimeCodeInput
Filament\Forms\Components\TextInput

// Notifications
Illuminate\Notifications\Notification

// Database model
Illuminate\Database\Eloquent\Model
Illuminate\Database\Eloquent\MassPrunable

// Service provider
Spatie\LaravelPackageTools\PackageServiceProvider
```

--------------------------------

### Schedule Command in Kernel

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/PruneOtpCodes.md

Automate the pruning process using Laravel's task scheduler.

```php
use Afsakar\FilamentOtpLogin\Commands\PruneOtpCodes;

protected function schedule(Schedule $schedule)
{
    // Run daily at 1:00 AM
    $schedule->command('otp-codes:prune')
        ->daily()
        ->at('01:00');
}
```

--------------------------------

### Navigate back to step 1

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/Login.md

Resets the authentication step to 1, typically triggered by a UI button.

```php
public function goBack(): void
```

```php
// Called by "Go Back" button in OTP step
```

--------------------------------

### Composer Configuration

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/FilamentOtpLoginServiceProvider.md

Required configuration for the composer.json file to register the service provider and facade.

```json
{
    "name": "afsakar/filament-otp-login",
    "description": "OTP Login for FilamentPHP",
    "extra": {
        "laravel": {
            "providers": [
                "Afsakar\\FilamentOtpLogin\\FilamentOtpLoginServiceProvider"
            ],
            "aliases": {
                "FilamentOtpLogin": "Afsakar\\FilamentOtpLogin\\Facades\\FilamentOtpLogin"
            }
        }
    }
}
```

--------------------------------

### FilamentOtpLoginPlugin Configuration

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/configuration.md

The plugin is configured via the FilamentOtpLoginPlugin class using a fluent builder pattern. Below are the available configuration methods.

```APIDOC
## FilamentOtpLoginPlugin Configuration Methods

### otpCode(int $length, int $expiresIn)
Configures the OTP code generation settings.
- **length** (int): Number of digits in the generated OTP code (Default: 6)
- **expiresIn** (int): Expiration time in seconds (Default: 120)

### identifierFormField(string $name, string $label, string $type)
Configures the login form field for user identification.
- **name** (string): Form field name
- **label** (string): Display label (Default: 'Email')
- **type** (string): HTML input type ('email', 'tel', 'phone', 'text') (Default: 'email')

### userIdentifierColumn(string $column)
Maps the form field to the column in the User model.
- **column** (string): Column name in the User model

### identifierColumn(string $column)
Specifies the column in the otp_codes table where identifiers are stored.
- **column** (string): Column name in otp_codes table (Default: 'identifier')

### userModel(string $model)
Specifies the User model class to use for authentication.
- **model** (string): Fully qualified class name (Default: App\\Models\\User)

### tableName(string $tableName)
Sets the database table name for storing OTP codes.
- **tableName** (string): Database table name (Default: 'otp_codes')

### rateLimit(int $attempts, int $decaySeconds)
Configures rate limiting for OTP code requests.
- **attempts** (int): Maximum allowed requests (Default: 5)
- **decaySeconds** (int): Time window in seconds (Default: 60)

### resendLimit(int $attempts, int $decaySeconds)
Configures rate limiting for resending OTP codes.
- **attempts** (int): Maximum resend attempts (Default: 3)
- **decaySeconds** (int): Time window in seconds (Default: 300)
```

--------------------------------

### Schedule Pruning with Logging

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/PruneOtpCodes.md

Configure the pruning command in the Laravel scheduler with success and failure logging callbacks.

```php
$schedule->command('otp-codes:prune')
    ->daily()
    ->at('01:00')
    ->onSuccess(function () {
        \Log::info('OTP codes pruned successfully');
    })
    ->onFailure(function () {
        \Log::error('OTP codes pruning failed');
    });
```

--------------------------------

### Define FilamentOtpLoginServiceProvider class

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/FilamentOtpLoginServiceProvider.md

The base class definition extending Spatie's PackageServiceProvider.

```php
namespace Afsakar\FilamentOtpLogin;

class FilamentOtpLoginServiceProvider extends PackageServiceProvider
```

--------------------------------

### Configuring Laravel package discovery

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/module-exports.md

The service provider is registered automatically via the composer.json extra configuration.

```json
{
    "extra": {
        "laravel": {
            "providers": [
                "Afsakar\\FilamentOtpLogin\\FilamentOtpLoginServiceProvider"
            ]
        }
    }
}
```

--------------------------------

### Create an OTP Code

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/OtpCode.md

Use the OtpCode model to store a hashed code with an expiration timestamp.

```php
use AfsakarilamentOtpLogin\Models\OtpCode;
use Illuminate\Support\Facades\Hash;

$plainCode = '123456';
$identifier = 'user@example.com';

$otpCode = OtpCode::create([
    'code' => Hash::make($plainCode),
    'identifier' => $identifier,
    'expires_at' => now()->addSeconds(300),
]);
```

--------------------------------

### Send OTP Method Definition

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/Login.md

Defines the method to initiate the OTP login flow.

```php
public function sendOtp(): void
```

--------------------------------

### getOtpCodeFormComponent()

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/Login.md

Creates the OTP input component for the second step of the login process.

```APIDOC
## getOtpCodeFormComponent()

### Description
Creates the OTP input component for step 2 of the login process. The component is configured with a specific length, required validation, and a 'Go Back' hint.

### Signature
`protected function getOtpCodeFormComponent(): Component`

### Returns
- **Component** - Configured `OneTimeCodeInput` field

### Example
```php
$component = $loginPage->getOtpCodeFormComponent();
```
```

--------------------------------

### Registering the plugin in the panel provider

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/module-exports.md

Manual registration of the plugin within the panel method of the panel provider.

```php
// app/Providers/Filament/AdminPanelProvider.php

public function panel(Panel $panel): Panel {
    return $panel
        ->plugins([
            FilamentOtpLoginPlugin::make()
        ]);
}
```

--------------------------------

### Implement canLoginDirectly with Audit Logging

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/CanLoginDirectly.md

Use this pattern to allow specific roles to bypass OTP while maintaining an audit trail of the bypass event.

```php
public function canLoginDirectly(): bool
{
    $canBypass = $this->role === 'admin';
    
    if ($canBypass) {
        \Log::info("User {$this->id} bypassing OTP", ['email' => $this->email]);
    }
    
    return $canBypass;
}
```

--------------------------------

### GetView Method Definition

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/Login.md

Method signature for retrieving the login page view.

```php
public function getView(): string
```

--------------------------------

### Monitor Database Table Metrics

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/PruneOtpCodes.md

SQL queries to inspect the size, record count, and oldest entry of the otp_codes table.

```sql
-- Check table size
SELECT 
    table_name,
    ROUND(((data_length + index_length) / 1024 / 1024), 2) as 'Size in MB'
FROM information_schema.tables
WHERE table_schema = 'database_name'
    AND table_name = 'otp_codes';

-- Check record count
SELECT COUNT(*) as record_count FROM otp_codes;

-- Check oldest record
SELECT MIN(expires_at) as oldest_record FROM otp_codes;
```

--------------------------------

### Configure Custom Login Page

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/configuration.md

Specifies a custom class for the login page. The custom class must extend the base plugin login page.

```php
->loginPage(login: '\Afsakar\FilamentOtpLogin\Filament\Pages\Login')
```

```php
FilamentOtpLoginPlugin::make()
    ->loginPage(\App\Filament\Pages\CustomLogin::class)
```

--------------------------------

### SendOtpCode Notification Methods

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/INDEX.md

Constructor and delivery methods for OTP notifications.

```php
public function __construct(string $code, int $expiresIn = 120)
public function via($notifiable)
public function toMail($notifiable)
```

--------------------------------

### Define Login page class

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/module-exports.md

Extends the base login page to provide step-based authentication and OTP verification.

```php
class Login extends BaseLogin
```

--------------------------------

### Create Identifier Input Component

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/Login.md

Retrieves the configured TextInput field for the first login step.

```php
protected function getEmailFormComponent(): Component
```

```php
$component = $loginPage->getEmailFormComponent();
```

--------------------------------

### Define OTP Login Form Step

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/Login.md

Method signature for the second step of the login form.

```php
public function otpForm(Schema $schema): Schema
```

--------------------------------

### Create OTP Input Component

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/Login.md

Retrieves the configured OneTimeCodeInput field for the second login step.

```php
protected function getOtpCodeFormComponent(): Component
```

```php
$component = $loginPage->getOtpCodeFormComponent();
```

--------------------------------

### Register Artisan Commands

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/FilamentOtpLoginServiceProvider.md

Defines the list of Artisan commands provided by the package and shows the command execution syntax.

```php
protected function getCommands(): array
{
    return [
        PruneOtpCodes::class,
    ];
}
```

```bash
php artisan otp-codes:prune
```

--------------------------------

### Implement canLoginDirectly with Two-Factor Enforcement

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/CanLoginDirectly.md

Ensure that users bypassing OTP still have other security mechanisms, such as a two-factor secret, configured.

```php
public function canLoginDirectly(): bool
{
    return $this->role === 'admin' 
        && $this->two_factor_secret !== null;
}
```

--------------------------------

### Configure Filament OTP Login Plugin

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/configuration.md

Register the plugin within the panel() method of your PanelProvider to customize OTP length, expiration, rate limits, and notification classes.

```php
<?php

namespace App\Providers\Filament;

use Afsakar\FilamentOtpLogin\FilamentOtpLoginPlugin;
use Filament\Http\Middleware\Authenticate;
use Filament\Http\Middleware\DisableBladeIconComponents;
use Filament\Http\Middleware\DispatchServingFilamentEvent;
use Filament\Pages;
use Filament\Panel;
use Filament\PanelProvider;
use Filament\Support\Colors\Color;
use Filament\Widgets;
use Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse;
use Illuminate\Cookie\Middleware\EncryptCookies;
use Illuminate\Foundation\Http\Middleware\VerifyCsrfToken;
use Illuminate\Session\Middleware\AuthenticateSession;
use Illuminate\Session\Middleware\StartSession;
use Illuminate\View\Middleware\ShareErrorsFromSession;

class AdminPanelProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            ->default()
            ->id('admin')
            ->path('admin')
            ->login()
            ->colors([
                'primary' => Color::Amber,
            ])
            ->discoverResources(in: app_path('Filament/Resources'), for: 'App\\Filament\\Resources')
            ->discoverPages(in: app_path('Filament/Pages'), for: 'App\\Filament\\Pages')
            ->pages([
                Pages\Dashboard::class,
            ])
            ->discoverWidgets(in: app_path('Filament/Widgets'), for: 'App\\Filament\\Widgets')
            ->widgets([
                Widgets\AccountWidget::class,
                Widgets\FilamentInfoWidget::class,
            ])
            ->middleware([
                EncryptCookies::class,
                AddQueuedCookiesToResponse::class,
                StartSession::class,
                AuthenticateSession::class,
                ShareErrorsFromSession::class,
                VerifyCsrfToken::class,
                DisableBladeIconComponents::class,
                DispatchServingFilamentEvent::class,
            ])
            ->authMiddleware([
                Authenticate::class,
            ])
            ->plugins([
                FilamentOtpLoginPlugin::make()
                    // OTP Code Settings
                    ->otpCode(length: 6, expiresIn: 300)
                    
                    // Identifier Settings (Email)
                    ->identifierFormField('email', label: 'Email Address', type: 'email')
                    ->userIdentifierColumn('email')
                    ->identifierColumn('identifier')
                    
                    // User Model
                    ->userModel('App\\Models\\User')
                    
                    // Database
                    ->tableName('otp_codes')
                    
                    // Rate Limiting
                    ->rateLimit(attempts: 5, decaySeconds: 60)
                    ->resendLimit(attempts: 3, decaySeconds: 300)
                    
                    // Authentication
                    ->passwordless(false)
                    
                    // Notification
                    ->notification(\Afsakar\FilamentOtpLogin\Notifications\SendOtpCode::class)
                    
                    // Login Page
                    ->loginPage(\Afsakar\FilamentOtpLogin\Filament\Pages\Login::class)
            ]);
    }
}
```

--------------------------------

### Authenticate Method Definition

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/Login.md

Defines the main authentication handler for the login button.

```php
public function authenticate(): ?LoginResponse
```

--------------------------------

### OtpCode Model Reference

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/INDEX.md

Methods and properties for the OTP code database model.

```php
public function isValid(): bool
public function prunable(): Builder
```

```php
public string $code
public string $identifier
public Carbon $expires_at
```

--------------------------------

### CanLoginDirectly Interface

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/module-exports.md

Interface to be implemented by the User model to support direct OTP login.

```APIDOC
## CanLoginDirectly Interface

### Description
Implement this interface on your User model to define the logic for direct login capabilities.

### Usage
```php
use Afsakar\FilamentOtpLogin\Models\Contracts\CanLoginDirectly;

class User extends Authenticatable implements CanLoginDirectly {
    public function canLoginDirectly(): bool {
        // Implementation
    }
}
```
```

--------------------------------

### Handle Database Connection Failures

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/PruneOtpCodes.md

Log errors when the pruning command fails to execute due to database connection issues.

```php
// In schedule() method
$schedule->command('otp-codes:prune')
    ->daily()
    ->onFailure(function ($output) {
        \Log::error('Prune failed: ' . $output);
    });
```

--------------------------------

### Configure OTP Code Settings

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/FilamentOtpLoginPlugin.md

Sets the length and expiration time for generated OTP codes.

```php
public function otpCode(int $length = 6, int $expiresIn = 120): static
```

```php
FilamentOtpLoginPlugin::make()
    ->otpCode(length: 6, expiresIn: 300)
```

--------------------------------

### Retrieve form actions

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/Login.md

Methods to define the action buttons for the identifier/password step and the OTP verification step.

```php
public function getFormActions(): array
```

```php
public function getOtpFormActions(): array
```

--------------------------------

### Command Execution

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/PruneOtpCodes.md

Commands to trigger the pruning process manually.

```bash
php artisan otp-codes:prune
```

--------------------------------

### Extending plugin components and interfaces

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/module-exports.md

Override login views, notification channels, or implement the CanLoginDirectly interface for custom user logic.

```php
// Extend login page
use Afsakar\FilamentOtpLogin\Filament\Pages\Login;

class CustomLogin extends Login {
    public function getView(): string {
        return 'custom-login';
    }
}

// Extend notification
use Afsakar\FilamentOtpLogin\Notifications\SendOtpCode;

class CustomOtpNotification extends SendOtpCode {
    public function via($notifiable) {
        return ['mail', 'vonage'];
    }
}

// Implement interface
use Afsakar\FilamentOtpLogin\Models\Contracts\CanLoginDirectly;

class User implements CanLoginDirectly {
    public function canLoginDirectly(): bool {
        return $this->is_admin;
    }
}
```

--------------------------------

### Configure Passwordless Authentication Mode

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/configuration.md

Sets the passwordless authentication state for the plugin. When enabled, users authenticate using only an identifier and OTP.

```php
->passwordless(condition: true)
```

```php
FilamentOtpLoginPlugin::make()
    ->passwordless(true)
```

```php
FilamentOtpLoginPlugin::make()
    ->passwordless(false)
```

--------------------------------

### Configure custom user model

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/FilamentOtpLoginPlugin.md

Defines the fully qualified class name of the User model to be used.

```php
public function userModel(string $model): static
```

```php
FilamentOtpLoginPlugin::make()
    ->userModel('App\Models\CustomUser')
```

--------------------------------

### Cron Job Configuration

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/PruneOtpCodes.md

Alternative method to schedule the command directly via crontab.

```cron
# Daily at 1:00 AM
0 1 * * * cd /path/to/app && php artisan otp-codes:prune >> /var/log/otp-prune.log 2>&1
```

--------------------------------

### Notification via Method

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/SendOtpCode.md

Specifies the delivery channels for the notification.

```php
public function via($notifiable)
```

```php
$channels = $notification->via($user);
// Returns: ['mail']
```

--------------------------------

### Verify Command Registration

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/PruneOtpCodes.md

Check if the command is correctly registered in the Artisan command list.

```bash
php artisan list | grep otp-codes
```

--------------------------------

### Implement CanLoginDirectly detection logic in PHP

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/CanLoginDirectly.md

This method validates user credentials and checks the CanLoginDirectly interface to determine whether to bypass OTP or proceed with the standard verification flow.

```php
// From src/Filament/Pages/Login.php

protected function checkCanLoginDirectly($data)
{
    $user = Filament::auth()->getProvider()->retrieveByCredentials(
        $this->getCredentialsFromFormData($data)
    );

    if (
        ($user instanceof CanLoginDirectly) &&
        ($user->canLoginDirectly())
    ) {
        // User implements interface and returns true
        $this->doLogin();
        
        $path = Filament::getCurrentPanel()->getPath();
        return redirect()->intended($path);
    } else {
        // User doesn't implement interface or returns false
        $this->generateCode();
        $this->sendOtpToUser($this->otpCode);
        $this->step = 2;
    }
}
```

--------------------------------

### passwordless(bool $condition)

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/FilamentOtpLoginPlugin.md

Enables or disables passwordless login mode (OTP only, no password required).

```APIDOC
## passwordless(bool $condition)

### Description
Enables or disables passwordless login mode (OTP only, no password required).

### Parameters
- **condition** (bool) - Optional (default: true) - Enable (true) or disable (false) passwordless login

### Returns
- **static** - Plugin instance for method chaining

### Example
```php
FilamentOtpLoginPlugin::make()->passwordless(true)
```
```

--------------------------------

### Class Definition for PruneOtpCodes

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/PruneOtpCodes.md

The base class definition for the command located in the package source.

```php
namespace Afsakar\FilamentOtpLogin\Commands;

class PruneOtpCodes extends Command
```

--------------------------------

### Create Custom Notification

Source: https://github.com/afsakar/filament-otp-login/blob/v2/_autodocs/api-reference/SendOtpCode.md

Implement a custom notification class to override default behavior and register it in the plugin configuration.

```php
<?php

namespace App\Notifications;

use Illuminate\Bus\Queueable;
use Illuminate\Notifications\Messages\MailMessage;
use Illuminate\Notifications\Messages\VonageMessage;
use Illuminate\Notifications\Notification;

class SendOtpCode extends Notification
{
    use Queueable;

    public function __construct(public string $code, public int $expiresIn)
    {
        //
    }

    public function via($notifiable)
    {
        // Send via multiple channels
        return ['mail', 'vonage'];
    }

    public function toMail($notifiable)
    {
        return (new MailMessage)
            ->subject('Your Login Code')
            ->greeting('Hello!')
            ->line('Your login code is: ' . $this->code)
            ->line('This code expires in ' . $this->expiresIn . ' seconds')
            ->salutation('Regards, ' . config('app.name'));
    }

    public function toVonage($notifiable)
    {
        return (new VonageMessage)
            ->content('Your login code is: ' . $this->code . '. It expires in ' . $this->expiresIn . ' seconds.');
    }
}
```

```php
FilamentOtpLoginPlugin::make()
    ->notification(\App\Notifications\SendOtpCode::class)
```
Tokens:
Raw