Download the PHP package alhaji-aki/laravel-phone-number-verification without Composer

Laravel Phone Number Verification

This is a simple package to help verify users phone number. This package uses alhaji-aki/laravel-otp-token to generate and send otp tokens to users

Installation

You can install the package via composer by running:

After the installation has completed, the package will automatically register itself. Run the following to publish the migration, config and lang file

This publishes a PhoneNumberVerificationController in App\Http\Controllers\Auth.

NOTE: This package does not work on views so you will have to do some minor changes if you want to display views instead json responses.

Since this package uses alhaji-aki/laravel-otp-token, you will have to publish its files

After publishing the files, you can run migrations:

Let your model implement the CanSendOtpToken contract and use the CanSendOtpToken trait like so:

To learn more about this check out alhaji-aki/laravel-otp-token.

Now let your model implement MustVerifyPhoneNumber contract and MustVerifyPhoneNumber trait to be able to allow users verify their phone numbers. Like this:

For this to work properly, you will have to override three methods in your User model. There are:

• phoneNumberAttribute(): This is the attribute that represents the phone number column in your database.
• phoneNumberVerificationAttribute(): This is the timestamp attribute that will be updated to indicate that a user is verified.
• sendPhoneNumberVerificationNotification(): This is where the notification will be sent. This receives the token to be sent.

An example implementation is:

If you want users to be notified when they register on your application add SendPhoneNumberVerificationNotification listener to listeners of the Registered event in the EventServiceProvider. Like this:

Dont forget to import the full namespace use \AlhajiAki\PhoneNumberVerification\Listeners\SendPhoneNumberVerificationNotification;

Finally, you will have to register the \AlhajiAki\PhoneNumberVerification\Middleware\EnsurePhoneNumberIsVerified::class middleware in your Http Kernel. Example:

Then you can protect your routes with that middleware.

Testing

Formatting

Static analysis

Contributing

Please see CONTRIBUTING for details.

License

The MIT License (MIT). Please see License File for more information.