一个简单的邀请系统API

dev-master 2016-02-10 20:49 UTC

This package is not auto-updated.

Last update: 2024-09-24 06:58:47 UTC


README

此包可以帮助您为注册或其他服务创建简单的邀请系统。

您可以使用laravel 5版本,链接如下 [https://github.com/Atbox/invi-l5]

功能

  • 通过电子邮件生成邀请码。
  • 设置过期日期
  • 启用或禁用邀请
  • 使用、未使用或删除

安装

在composer.json的require部分添加以下内容

"sajjadrad/invi": "dev-master"

在app/config/app.php的providers数组末尾添加以下内容

'Sajjadrad\Invi\InviServiceProvider',

执行

composer update

如果找不到Invi类,请运行以下命令进行自动加载

php artisan dump-autoload

示例

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

生成邀请码

  • 参数
    • 电子邮件
    • 过期日期:2年2个月13天1小时23分40秒
    • 启用
  • 返回
    • 所有邀请信息的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

验证邀请码

  • 参数
    • 邀请码
    • 电子邮件
  • 返回
    • 布尔值
Invi::check("f22c597305eb1800","example@domain.com");

状态

返回邀请码状态

  • 参数
    • 邀请码
    • 电子邮件
  • 返回
    • 状态:启用、禁用、已使用、有效、不存在
echo Invi::status("f22c597305eb1800","example@domain.com");

启用

激活邀请

  • 参数
    • 邀请码
    • 电子邮件
Invi::active("f22c597305eb1800","example@domain.com");

deactive

禁用邀请

  • 参数
    • 邀请码
    • 电子邮件
Invi::deactive("f22c597305eb1800","example@domain.com");

used

使邀请码被使用

  • 参数
    • 邀请码
    • 电子邮件
Invi::used("f22c597305eb1800","example@domain.com");

unused

使邀请码未被使用

  • 参数
    • 邀请码
    • 电子邮件
Invi::unused("f22c597305eb1800","example@domain.com");

delete

删除邀请码

  • 参数
    • 邀请码
    • 电子邮件
Invi::delete("f22c597305eb1800","example@domain.com");

许可证

MIT许可证(MIT)

版权所有(c)2014 Sajjad Rad

http://sajjadrad.com https://github.com/sajjadrad/invi-l4

本许可证免费授予任何获得此软件及其相关文档副本(以下简称“软件”)的人,允许在不受限制的情况下处理软件,包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本,并允许向软件提供的人这样做,但受以下条件的约束

上述版权声明和本许可证声明应包含在软件的所有副本或主要部分中。

软件按“原样”提供,不提供任何明示或暗示的保证,包括但不限于适销性、特定用途适用性和非侵权性保证。在任何情况下,作者或版权所有者不对任何索赔、损害或其他责任负责,无论这些责任是因合同、侵权或其他方式引起的,包括但不限于软件或其使用或其它处置引起的软件或其它任何责任。

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