README

Larainvite 是一个 Laravel 包，允许现有用户通过电子邮件邀请他人。

它生成一次性邀请码，可以作为邀请链接发送，并跟踪邀请状态。

• v7 支持 Laravel 11
• v6 支持 Laravel 10
• v5 支持 Laravel 9
• v4 支持 Laravel 8
• v3 支持 Laravel 5.8+，Laravel 6.0 和 Laravel 7.0
• v2 支持 Laravel 5.0 到 5.8
• v1 支持 Laravel 4.*

安装

首先通过 Composer 安装该包。在您的终端中运行以下命令

composer require junaidnasir/larainvite

在 config/app.php 中的 providers 数组中添加包服务提供者

Junaidnasir\Larainvite\LaraInviteServiceProvider::class

您可以在 aliases 数组中添加 facade 访问

'Invite'  => Junaidnasir\Larainvite\Facades\Invite::class

发布迁移和配置文件

php artisan vendor:publish --provider="Junaidnasir\Larainvite\LaraInviteServiceProvider"

迁移以创建 user_invitation 表

php artisan migrate

编辑您的 User 模型以包含 larainviteTrait

use Junaidnasir\Larainvite\InviteTrait;
class user ... {
    use InviteTrait;
}

用法

您可以使用 facade 访问器 来检索包控制器。示例

$user = Auth::user();
//Invite::invite(EMAIL, REFERRAL_ID); 
$refCode = Invite::invite('email@address.com', $user->id);
//or 
//Invite::invite(EMAIL, REFERRAL_ID, EXPIRATION); 
$refCode = Invite::invite('email@address.com', $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;
});

现在创建带有 refCode 的路由，当用户访问该路由时，您可以使用以下方法

// 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
}

借助新的特质，您可以访问用户发送的邀请

$user= User::find(1);
$invitations = $user->invitations;
$count = $user->invitations()->count();

事件

larainvite 触发多个 事件

• Junaidnasir\Larainvite\Events\Invited
• Junaidnasir\Larainvite\Events\InvitationConsumed
• Junaidnasir\Larainvite\Events\InvitedCanceled
• Junaidnasir\Larainvite\Events\Expired

所有这些事件都包含 邀请模型，因此您可以监听这些事件。在 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);
        });
}

配置

在 config/larainvite.php 中，您可以设置从当前时间起默认的过期时间（以小时为单位）。

'expires' => 48

您还可以更改要使用的用户模型，在 larainvite.php

'UserModel' => 'App\User'

您还可以更改要使用的邀请模型，在 larainvite.php

'InvitationModel' => 'App\Invitation'