README

Laravel 5的Invi包

此包可以帮助您为注册或其他服务创建一个简单的邀请系统。[https://packagist.org.cn/packages/atbox/invi]

特性

为给定的电子邮件生成邀请码
为邀请设置过期日期
激活或停用邀请
使用、停用或删除邀请

安装

Laravel 5.4

composer require atbox/invi ^2.0

Laravel 5.0至5.3

composer require atbox/invi ^1.0

执行

composer update

将此添加到config/app.php中的提供者数组的末尾

Atbox\Invi\InviServiceProvider::class,

将此添加到config/app.php中的别名数组的末尾

'Invi' => Atbox\Invi\Facades\Invi::class,

发布迁移文件

php artisan vendor:publish

运行迁移命令

php artisan migrate

示例

Invi::generate("example@domain.com", "2 day", true); // Generate Invitation

if(Invi::check("f22c597305eb1800", "example@domain.com"))
    Invi::used("f22c597305eb1800", "example@domain.com");
else
    echo Invi::status("f22c597305eb1800", "example@domain.com");

函数

generate

生成邀请码

参数
- email
- 过期日期，接受如下时间段：2年 | 2个月 | 13天 | 1小时 | 23分钟 | 40秒
- active
返回
- 所有邀请信息的JSON数组

Invi::generate("example@domain.com", "2 day", true); // Generate Invitation

输出

{"code":"f22c5973ebbcca99","email":"example@domain.com","expiration":"2013-05-10 15:58:41 ","active":true,"used":"0"}

check

验证邀请码

参数
- 邀请码
- email
返回
- 布尔值

Invi::check("f22c597305eb1800", "example@domain.com");

状态

返回邀请码状态

参数
- 邀请码
- email
返回
- 状态：激活、停用、已使用、有效、不存在

echo Invi::status("f22c597305eb1800", "example@domain.com");

active

激活邀请

参数
- 邀请码
- email

Invi::active("f22c597305eb1800", "example@domain.com");

deactive

停用邀请

参数
- 邀请码
- email

Invi::deactive("f22c597305eb1800", "example@domain.com");

used

使邀请已使用

参数
- 邀请码
- email

Invi::used("f22c597305eb1800", "example@domain.com");

unused

使邀请未使用

参数
- 邀请码
- email

Invi::unused("f22c597305eb1800", "example@domain.com");

delete

删除邀请

参数
- 邀请码
- email

Invi::delete("f22c597305eb1800", "example@domain.com");

许可

MIT许可 (MIT)

http://atbox.io https://github.com/atbox/invi-l5

以下是对任何人免费提供此软件及其相关文档文件（“软件”）的副本的许可，允许任何人在不受限制的情况下处理软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本，并允许向提供软件的个人提供此类软件以进行上述操作，前提是遵守以下条件

https://open-source.org.cn/licenses/MIT

atbox / invi

维护者

详细信息