Download the PHP package rasulian/laravel-user-verification without Composer
On this page you can find all versions of the php package rasulian/laravel-user-verification. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download rasulian/laravel-user-verification
More information about rasulian/laravel-user-verification
Files in rasulian/laravel-user-verification
Package laravel-user-verification
Short Description A package for user email and phone number verification with activation code
License MIT
Informations about the package laravel-user-verification
laravel-user-verification
A simple package to activate the users by token and code number.
This package allows you to verify the users either by token to be sent by email and code number for SMS.
Installation
This package can be used in Laravel 5.4 or higher.
You can install the package via composer:
In Laravel 5.5 the service provider will automatically get registered. In older versions of the framework just add the service provider in config/app.php file:
You may add the following aliases to your config/app.php:
Publish the package config and database migration file by running the following command:
Configuration
Migration
The table representing the user model must be updated with the verified
column. This update will be performed by the migration included with this package.
Please make sure that you don't have the this column on your user table.
If your user table name is not users
, you may change that in the config/verification.php
.
Now you can migrate the normal way you do:
Middleware
This package provides an optional middleware throwing UserVerifiedMiddleware
.
Please refer to the Laravel Documentation to learn more
about how to work with the exception handler.
To register the default middleware add the following lines to the $routeMiddleware
array within the app/Http/Kernel.php
file:
You may use this middleware for the routes that needs the user's email or phone number be verified:
Errors
This package throws several exception. you may use try\catch
statement or the Laravel exception handler.
UserIsVerifiedException
The given user is already verifiedUserNotVerifiedException
The given user is not verifiedVerifyTokenMismatchException
The given token is wrong or not availableVerifyCodeMismatchException
The given code is wrong or not available
Usage
Route
By default this package provide one route to verify the user by token.
Overriding package route
To define your own custom routes, put the package service provider call before the RouteServiceProvider
call in the config/app.php
file.
Then, add your custom route in your route file.
Facade
The package offers a facade Verification::.
verification Config file
After publishing the package config, it will be located at the config
directory. You are free to change the table name
for the user
and the user_verifications
which represents the fields for storing the token and code.
How to use the package
This package is written as simple as possible. It creates a token and code for the user and verifies the user either by token or code.
Here is a sample on how to generate a token, send it as an email and verify it.
Edit the App\Http\Auth\RegisterController
file:
Here we use the registered
method to create token and send it,
which will overrides \Illuminate\Foundation\Auth\RegistersUsers@registered
method.
We get a token for the given user, make it as a url and send it as an email.
If the user clicks on the link, the verifyUser
method will be executed.
Here we just verify the user by the given token.
Please make sure that you add the verifyUser
to the except
array of the guest
middleware in the constructor.
Relaunch the process
If you want to regenerate and resend the verification token, you can do this with the getVerificationToken
method.
The generate method will generate a new token for the given user and change the verified
column to false
.
CONTRIBUTE
Feel free to comment, contribute and help. 1 PR = 1 feature.
LICENSE
Laravel User Verification is licensed under The MIT License (MIT).