laravie / authen
User Authentication Identifiers for Laravel
Fund package maintenance!
Liberapay
paypal.me/crynobone
Installs: 58 090
Dependents: 1
Suggesters: 0
Security: 0
Stars: 64
Watchers: 2
Forks: 2
Open Issues: 0
Requires
- php: ^7.3 || ^8.0
- illuminate/auth: ^8.75 || ^9.45 || ^10.0
Requires (Dev)
- nunomaduro/larastan: ^1.0.1 || ^2.0
- orchestra/testbench: ^6.25.1 || ^7.19 || ^8.0
- phpunit/phpunit: ^9.5.10
README
Imagine you need to login a user with either "email", "username" or "phone number" just like how Facebook allows it. This is not possible with Laravel since you're limited to only one unique username/identifier key. This package attempt to solve the issue by allowing to use a unified key "identifier" and you can customize which attributes Laravel should check during authentication.
Installation
To install through composer, run the following command from terminal:
composer require "laravie/authen"
Usages
Service Provider
First you can attach the auth provider on App\Providers\AuthServiceProvider
:
<?php namespace App\Providers; use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider; use Laravie\Authen\BootAuthenProvider; class AuthServiceProvider extends ServiceProvider { use BootAuthenProvider; /** * Register any authentication / authorization services. * * @return void */ public function boot() { $this->registerPolicies(); $this->bootAuthenProvider(); } }
User Model
Secondly, you need to update the related App\User
(or the eloquent model mapped for auth).
<?php namespace App; use Illuminate\Notifications\Notifiable; use Illuminate\Foundation\Auth\User as Authenticatable; use Laravie\Authen\AuthenUser; class User extends Authenticatable { use Notifiable, AuthenUser; /** * Get the name of the unique identifier for the user. * * @return array<int, string> */ public function getAuthIdentifiersName() { return ['email', 'username', 'phone_number']; } }
With this setup, you can now check either email
, username
or phone_number
during authentication.
Configuration
Lastly, you need to update the config config/auth.php
:
<?php return [ // ... 'providers' => [ 'users' => [ 'driver' => 'authen', 'model' => App\User::class, ], ], // ... ];
Examples
Here's an example how to login.
<?php use Illuminate\Support\Facades\Auth; use Laravie\Authen\Authen; $data = [Authen::getIdentifierName() => 'crynobone@gmail.com', 'password' => 'foobar']; if (Auth::attempt($data)) { // you can logged in, you can also pass your phone number of username to `identifier`. }