lampge / laravel-invitation
Laravel 邀请码套件
v0.0.8
2018-12-13 06:47 UTC
Requires
- php: >=7.1.2
- illuminate/database: ~5.6
- illuminate/support: ~5.6
- lampge/ulid: ^0.2.6
Requires (Dev)
- mockery/mockery: ^1.0
- orchestra/database: ~3.6
- orchestra/testbench: ~3.6
- phpunit/phpunit: ~7.1.4
README
介紹
此套件可用來實作邀请码管理,每個會員可能都會有一個邀请码,或是多個邀请码
本專案參考 clarkeash/doorman 完成,因為作者有些限制與我的需求不合(比方說沒有邀请码製作者、擁有者、狀態、類型等..),因此此套件參考他的套件擴充,並儘量改成更彈性的使用
安裝
以 composer 安裝
composer require ariby/invitation
config
table 名稱定義於 config `laravel_invitation` 檔案中,可發佈後進行修改 `invite_table_name` 欄位,預設為`invites`
另一個可修改參數是邀请码長度 `code_length`,預設為 5
Table 結構
| 欄位名稱 | 說明
|--------------------------------------------------------------------------
| 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 Query Scope
$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();
...
}
```