README

介绍

本套件可用于实现邀请码管理，每个会员可能都有一个或多个邀请码

本项目参考 clarkeash/doorman 完成，因为作者有些限制与我的需求不符（例如没有邀请码的创建者、拥有者、状态、类型等），因此此套件参考他的套件扩展，并尽量改为更灵活的使用

安装

以 composer 安裝

composer require ariby/invitation

配置

table 名稱定義於 config `laravel_invitation` 檔案中，可發佈後進行修改 `invite_table_name` 欄位，預設為`invites`

另一個可修改參數是邀请码長度 `code_length`，預設為 5

表结构

    |   欄位名稱   |   說明 
    |--------------------------------------------------------------------------
    |    code     |  邀请码  
    |--------------------------------------------------------------------------
    |   status    | 邀请码的開放狀態 (enum => ['enabled', 'disabled']) ->default('enabled')
    |--------------------------------------------------------------------------
    |    for      | 邀请码的專屬使用者 (null 表示所有人都可以使用)
    |--------------------------------------------------------------------------
    |  belong_to  | 邀请码的擁有者 (nullable)
    |--------------------------------------------------------------------------
    |   made_by   | 邀请码的製作者 (nullable)
    |--------------------------------------------------------------------------
    |    max      | 邀请码的最大使用次數 (null 表示無限)
    |--------------------------------------------------------------------------
    |    uses     | 邀请码的已使用次數 ->default('0')
    |--------------------------------------------------------------------------
    |    type     | 邀请码的類型 (nullable)
    |--------------------------------------------------------------------------
    | valid_until | 邀请码的有效期限 (null 表示永久)

ORM 可使用函数

$model->isExpired() => 回傳是否已過期

$model->isEnabled() => 回傳是否狀態為開放使用

$model->isFull() => 回傳是否已超過最大使用次數

$model->isRestricted() => 回傳此推廣碼是否有綁定特定使用者

$model->isRestrictedFor($userId) => 回傳此邀请码是否為此會員專屬

$model->isUseless() => 回傳此邀请码是否已無法使用(超過使用次數或已過期)

ORM 查询范围

$builder->expired() // 取得已過期的邀请码

$builder->full() // 取得已超過使用次數上限的邀请码

$bulider->useless() // 取得已無法使用的邀请码(超過使用次數或已過期)

创建邀请码

使用範例

```
$inviteCode = LaravelInvitation::generate()
                ->setCode($code) // 指定邀请码，若不使用會自動隨機產生
                ->status('enabled') // 是否開放使用，不使用預設為 enabled
                ->belongTo($this->id) // 屬於特定代理 id
                ->madeBy($this->id) // 製作者 id
                ->expiresOn('2018-11-26 12:00:00') // 過期日期
                ->type($type) // 此邀请码類型
                ->make()
                ->first();
```

命令与排程

排程清除已經過期的邀请码

`php artisan routine-clear:clear-expired-invite-codes`

或是將此命令加入 kernel 排程

```
    protected function schedule(Schedule $schedule)
    {
        ...
        // 每天清除已過期的邀请码
        $schedule->command('routine-clear:clear-expired-invite-codes')->daily();
        ...
    }
```