larainvite
User (signup) invitation package for laravel
- v5 support laravel 9
- v4 support laravel 8
- v3 support laravel 5.8+, laravel 6.0 and laravel 7.0
- v2 support laravel 5.0 to 5.8
- v1 support laravel 4.*
larainvite is a laravel package, to allow existing users to invite others by email.
It generates referral code and keep track of status.
Installation
Begin by installing the package through Composer. Run the following command in your terminal:
composer require junaidnasir/larainviteadd the package service provider in the providers array in config/app.php:
Junaidnasir\Larainvite\LaraInviteServiceProvider::classyou may add the facade access in the aliases array:
'Invite' => Junaidnasir\Larainvite\Facades\Invite::classpublish the migration and config file:
php artisan vendor:publish --provider="Junaidnasir\Larainvite\LaraInviteServiceProvider"migrate to create user_invitation table
php artisan migrateedit your User model to include larainviteTrait
use Junaidnasir\Larainvite\InviteTrait;
class user ... {
use InviteTrait;
}Usage
You can use facade accessor to retrieve the package controller. Examples:
$user = Auth::user();
//Invite::invite(EMAIL, REFERRAL_ID);
$refCode = Invite::invite('[email protected]', $user->id);
//or
//Invite::invite(EMAIL, REFERRAL_ID, EXPIRATION);
$refCode = Invite::invite('[email protected]', $user->id, '2016-12-31 10:00:00');
//or
//Invite::invite(EMAIL, REFERRAL_ID, EXPIRATION, BEFORE_SAVE_CALLBACK);
$refCode = Invite::invite($to, Auth::user()->id, Carbon::now()->addYear(1),
function(/* InvitationModel, see Configurations */ $invitation) use ($someValue) {
$invitation->someParam = $someValue;
});now create routes with refCode, when user access that route you can use following methods
// Get route
$code = Request::input('code');
if( Invite::isValid($code))
{
$invitation = Invite::get($code); //retrieve invitation modal
$invited_email = $invitation->email;
$referral_user = $invitation->user;
// show signup form
} else {
$status = Invite::status($code);
// show error or show simple signup form
}// Post route
$code = Request::input('code');
$email = Request::input('signup_email');
if( Invite::isAllowed($code,$email) ){
// Register this user
Invite::consume($code);
} else {
// either refCode is inavalid, or provided email was not invited against this refCode
}with help of new trait you have access to invitations sent by user
$user= User::find(1);
$invitations = $user->invitations;
$count = $user->invitations()->count();Events
larainvite fires several events
- Junaidnasir\Larainvite\Events\Invited
- Junaidnasir\Larainvite\Events\InvitationConsumed
- Junaidnasir\Larainvite\Events\InvitedCanceled
- Junaidnasir\Larainvite\Events\Expired
all of these events incloses invitation modal so you can listen to these events.
include listener in EventServiceProvider.php
use Junaidnasir\Larainvite\Events\Invited;
use App\Listeners\SendUserInvitationNotification;
protected $listen = [
Invited::class => [
SendUserInvitationNotification::class,
],
];userInvite.php
public function handle($invitation)
{
\Mail::queue('invitations.emailBody', $invitation, function ($m) use ($invitation) {
$m->from('From Address', 'Your App Name');
$m->to($invitation->email);
$m->subject("You have been invited by ". $invitation->user->name);
});
}Configurations
in config/larainvite.php you can set default expiration time in hours from current time.
'expires' => 48you can also change user model to be used, in larainvite.php
'UserModel' => 'App\User'you can also change invitation model to be used, in larainvite.php
'InvitationModel' => 'App\Invitation'