2017 © Pedro Peláez
 

library users-verification

Laravel Package for managing users verification.

image

ahmedash95/users-verification

Laravel Package for managing users verification.

  • Tuesday, June 20, 2017
  • by ahmedash95
  • Repository
  • 1 Watchers
  • 4 Stars
  • 7 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 3 Versions
  • 0 % Grown

The README.md

Laravel Users Verification

This package contains a trait to support Eloquent Models Verification, (*1)

$user = App\User::find(1);

// Generate token or get it if exists
$user->getToken();

// check if user is verified or not
$user->isVerified()

// check if token is valid for user
$token = 'random_token_generated_by_getToken()_method'
$user->verifyToken($token) // return true or false

// verify the user
if($user->verifyToken($token)) {
    $user->verify();
}

// remove user token
$user->flushToken();

Installation

You can install the package via composer:, (*2)

composer require ahmedash95/users-verification

Next up, the service provider must be registered:, (*3)

// config/app.php
'providers' => [
    ...
    Ahmedash95\UsersVerification\UsersVerificationServiceProvider::class,

];

you must publish the migration file:, (*4)

php artisan vendor:publish --provider="Ahmedash95\UsersVerification\UsersVerificationServiceProvider" --tag="migrations"

then run the migration command, (*5)

php artisan migrate

Use verification in User model

use Illuminate\Foundation\Auth\User as Authenticatable;

use Ahmedash95\UsersVerification\UsersVerification;

class User extends Authenticatable
{
    use UsersVerification;

Available Methods

Get\Generate token for user

The getToken method will return the user token string or generate it if it doesn't not exists., (*6)

public function getToken() : string

Check user token

This method will verify if the given token is valid for the user, (*7)

public function verifyToken(String $token) : bool

Verify the user

After checking if the token is valid you may want to activate user verification .. then you should use verify method, (*8)

public function verify()

Get user by token

If you want to validate your users using token you could use findByToken method, (*9)

public static function findByToken($token)

this method return object of user or null if doesn't exists, (*10)

Remove user's token

public function flushToken()

Security

If you discover any security related issues, please email ahmed29329@gmail.com instead of using the issue tracker., (*11)

Credits

License

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

The Versions

20/06 2017

dev-master

9999999-dev

Laravel Package for managing users verification.

  Sources   Download

MIT

20/06 2017

0.0.2

0.0.2.0

Laravel Package for managing users verification.

  Sources   Download

MIT

20/06 2017

0.0.1

0.0.1.0

Laravel Package for managing users verification.

  Sources   Download

MIT