Download the PHP package youngmayor/laravel-otp without Composer
On this page you can find all versions of the php package youngmayor/laravel-otp. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download youngmayor/laravel-otp
More information about youngmayor/laravel-otp
Files in youngmayor/laravel-otp
Package laravel-otp
Short Description A laravel package for generating and validating One Time Pins
License MIT
Homepage https://github.com/youngmayor/laravel-otp
Informations about the package laravel-otp
Laravel OTP
A laravel package to create, validate and manage OTPs.
Installation
You can install the package via composer:
The package uses auto discovery hence if you use Laravel 5.5 or above, installing the package automatically registers it in your application.
However, if you use Laravel 5.4 or below you will need to add the below snipet to your config/app.php
to register the Service Provider and alias
Next step is to publish the configuration for the package. This can be done using the command below
This copies the package configuration into config/laravel-otp.php
Then you run migration to create the OTP tables
Usage
Models which intend to manage OTP codes should extend the YoungMayor\LaravelOtp\Traits\OTPActions
trait
It is required that the model posses an email field. This field would store the recipient of the generate OTP code. It is assumed that this field is named email. If the field has a different name, then it should be configured using the below code
OTPs can now be managed using that model.
OTP Creation
This generates an OTP using the configuration defined in config/laravel-otp.php
and emails the generate OTP to the email attached to the model
OTP Validation
If the pin is correct an instance of YoungMayor\LaravelOtp\Models\OneTimePin
would be returned, else null would be returned
Managing OTP
The OTP can now be managed as below
Relationships
Every model which utilises the OTPActions
trait have the otps
relationship and can perform laravel one to many relationshp on it.
Likewise, from the YoungMayor\LaravelOtp\Models\OneTimePin
instance. You can retrieve the source model using the source relationship method
Exceptions
The package renders two exceptions:
-
YoungMayor\LaravelOtp\Exceptions\InvalidAction
exception: Thrown when an attempt togenerateOTP()
orvalidateOTP()
is made with an action that is not registered in theconfig/laravel-otp.php
file. YoungMayor\LaravelOtp\Exceptions\InvalidSource
exception: Thrown when the given source does not use theOTPActions
trait
Testing
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Meyoron Aghogho
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
Laravel Package Boilerplate
This package was generated using the Laravel Package Boilerplate.