PHP Class InviteModel, thinksns

Author: Micha (lupochen)
Inheritance: extends RoxModelBase
显示文件 Open project: medz/thinksns-4 Class Usage Examples

Protected Properties

Property Type Description
$tableName

Public Methods

Method Description
applyInviteCode ( integer $uid, string $type ) : boolean 普通用户获取邀请码操作
checkInviteCode ( string $code, string $type ) : integer 检验验证码是否可用
createInviteCode ( integer $uid, string $type, integer $num = 5, boolean $isAdmin = false ) : boolean | string 生成邀请码
doInvite ( array $email, string $detail, integer $uid, boolean $isAdmin = false ) : boolean 邮件邀请注册
getAdminInviteCode ( string $type ) : array 获取后台邀请码列表
getAvailableCodeCount ( integer $uid, string $type ) : integer 获取指定用户可用的邀请码个数
getInviteAdminUserList ( array $type ) : array 获取指定用户所邀请的用户列表
getInviteCode ( integer $uid, string $type ) : array 获取指定用户的邀请码列表 - 链接邀请使用
getInviteCodeInfo ( string $code ) : array 获取指定邀请码的相关信息
getInviteUserList ( integer $uid, array $type, boolean $isAdmin = false ) : array 获取指定用户所邀请的用户列表
getInviterInfoByCode ( string $code ) : array 通过邀请码获取邀请人相关信息
getPage ( array $map = [], integer $pageNums = 10 ) : array 获取邀请结果列表,用于后台 - 分页型
getTopPage ( string $where = '', integer $pageNums = '20' ) : array 获取邀请排行信息
setInviteCodeUsed ( string $code, array $receiverInfo ) : boolean 设置指定验证码已被使用

Method Details

applyInviteCode() public method

普通用户获取邀请码操作
public applyInviteCode ( integer $uid, string $type ) : boolean
$uid integer 用户ID
$type string 邀请码类型
return boolean 是否获取邀请码成功

checkInviteCode() public method

检验验证码是否可用
public checkInviteCode ( string $code, string $type ) : integer
$code string 验证码
$type string 注册类型
return integer 邀请码使用情况,0:邀请码不存在,1:邀请码可用,2:邀请码已被使用

createInviteCode() public method

生成邀请码
public createInviteCode ( integer $uid, string $type, integer $num = 5, boolean $isAdmin = false ) : boolean | string
$uid integer 用户ID
$type string 邀请码类型
$num integer 邀请码数量,默认为5
$isAdmin boolean 是否为管理员邀请操作,默认为false
return boolean | string 成功返回邀请码,失败返回false

doInvite() public method

邮件邀请注册
public doInvite ( array $email, string $detail, integer $uid, boolean $isAdmin = false ) : boolean
$email array 被邀请人邮箱数组
$detail string 邀请相关信息
$uid integer 邀请人ID
$isAdmin boolean 是否为管理员邀请操作,默认为false
return boolean 是否发送邀请成功

getAdminInviteCode() public method

获取后台邀请码列表
public getAdminInviteCode ( string $type ) : array
$type string 邀请码类型
return array 后台邀请码列表

getAvailableCodeCount() public method

获取指定用户可用的邀请码个数
public getAvailableCodeCount ( integer $uid, string $type ) : integer
$uid integer 用户ID
$type string 邀请码类型,email或者link
return integer 指定用户可用的邀请码个数

getInviteAdminUserList() public method

获取指定用户所邀请的用户列表
public getInviteAdminUserList ( array $type ) : array
$type array 邀请类型
return array 指定用户所邀请的用户列表

getInviteCode() public method

获取指定用户的邀请码列表 - 链接邀请使用
public getInviteCode ( integer $uid, string $type ) : array
$uid integer 用户ID
$type string 邀请码类型
return array 指定用户的邀请码列表

getInviteCodeInfo() public method

获取指定邀请码的相关信息
public getInviteCodeInfo ( string $code ) : array
$code string 邀请码
return array 指定邀请码的相关信息

getInviteUserList() public method

获取指定用户所邀请的用户列表
public getInviteUserList ( integer $uid, array $type, boolean $isAdmin = false ) : array
$uid integer 用户ID
$type array 邀请类型
$isAdmin boolean 是否为管理员操作,默认为false
return array 指定用户所邀请的用户列表

getInviterInfoByCode() public method

通过邀请码获取邀请人相关信息
public getInviterInfoByCode ( string $code ) : array
$code string 邀请码
return array 获取邀请人相关信息

getPage() public method

获取邀请结果列表,用于后台 - 分页型
public getPage ( array $map = [], integer $pageNums = 10 ) : array
$map array 查询条件
$pageNums integer 结果集数目,默认为10
return array 邀请结果列表

getTopPage() public method

获取邀请排行信息
public getTopPage ( string $where = '', integer $pageNums = '20' ) : array
$where string 查询条件
$pageNums integer 结果集数目,默认为20
return array 邀请排行信息

setInviteCodeUsed() public method

设置指定验证码已被使用
public setInviteCodeUsed ( string $code, array $receiverInfo ) : boolean
$code string 验证码
$receiverInfo array 邀请人用户信息
return boolean 设置是否成功

Property Details

$tableName protected_oe property

protected $tableName