Installation & Setup
Last updated:
On this page
You can install the package via composer:
composer require javaabu/mobile-verification
Publishing Migrations
php artisan vendor:publish --provider="Javaabu\MobileVerification\MobileVerificationServiceProvider" --tag="mobile-verification-migrations"
Publishing Translations
php artisan vendor:publish --provider="Javaabu\MobileVerification\MobileVerificationServiceProvider" --tag="mobile-verification-translations"
Publishing Config
php artisan vendor:publish --provider="Javaabu\MobileVerification\MobileVerificationServiceProvider" --tag="mobile-verification-config"
This is the default content of the config file:
<?php
return [
/*
|--------------------------------------------------------------------------
| Mobile Number Database connection
|--------------------------------------------------------------------------
| This is the database connection that will be used by the mobile numbers
| migration and the MobileNumber model shipped with this package. In case
| it's not set Laravel's database.default will be used instead.
*/
'database_connection' => env('MOBILE_NUMBER_DB_CONNECTION'),
/*
|--------------------------------------------------------------------------
| Mobile Numbers table name
|--------------------------------------------------------------------------
| This is the name of the table that will be created by the mobile numbers
| migration and used by the MobileNumber model shipped with this package.
*/
'table_name' => 'mobile_numbers',
/*
|--------------------------------------------------------------------------
| Mobile Number Model
|--------------------------------------------------------------------------
| This model will be used to save mobile numbers.
| It should implement the Javaabu\MobileVerification\Contracts\MobileNumber interface
| and extend Illuminate\Database\Eloquent\Model.
*/
'mobile_number_model' => \Javaabu\MobileVerification\Models\MobileNumber::class,
/*
|--------------------------------------------------------------------------
| Default country code
|--------------------------------------------------------------------------
| The country code to be used by default
*/
'default_country_code' => env('MOBILE_NUMBER_DEFAULT_COUNTRY_CODE', '960'),
/*
|--------------------------------------------------------------------------
| Allowed country codes
|--------------------------------------------------------------------------
| Which country codes are allowed
*/
'allowed_country_codes' => explode(',', env('MOBILE_NUMBER_ALLOWED_COUNTRY_CODES', '960')),
/*
|--------------------------------------------------------------------------
| Number prefix
|--------------------------------------------------------------------------
| The prefix to add before fully qualified numbers
*/
'number_prefix' => '+',
/*
|--------------------------------------------------------------------------
| Token validity
|--------------------------------------------------------------------------
| The number of minutes that a mobile number verification token
| would be valid for.
*/
'verification_code_validity' => 10, // minutes
/*
|--------------------------------------------------------------------------
| Maximum attempts
|--------------------------------------------------------------------------
| The maximum number of validation attempts that can be made before which
| the number would get locked for a specific length of time.
*/
'max_attempts' => 5,
/*
|--------------------------------------------------------------------------
| Attempt expiry
|--------------------------------------------------------------------------
| The number of minutes that a number would get locked for if there are too
| many verification attempts for that number.
*/
'attempt_expiry' => 30, // minutes
/*
|--------------------------------------------------------------------------
| Resend interval
|--------------------------------------------------------------------------
| The number of seconds after which a verification code can be resent to
| the same mobile number.
*/
'resend_interval' => 30, // seconds
/*
|--------------------------------------------------------------------------
| Verified
|--------------------------------------------------------------------------
| Whether the mobile number should be verified
*/
'verified' => env('MOBILE_NUMBER_VERIFIED', true),
/*
|--------------------------------------------------------------------------
| Use Recaptcha
|--------------------------------------------------------------------------
| Whether the use Recaptcha to prevent SPAM OTP requests
*/
'use_recaptcha' => env('MOBILE_NUMBER_USE_RECAPTCHA', true),
];