Fresns用户功能
创建用户
php
\FresnsCmdWord::plugin('Fresns')->createUser($wordBody);\FresnsCmdWord::plugin('Fresns')->createUser($wordBody);| 参数名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| aid | String | YES | 关联字段 accounts->aid |
| aidToken | String | NO | 不传则不验证账号身份，直接为该账号添加用户 |
| platformId | Number | NO | 平台编号，传 aidToken 时必传 |
| version | String | NO | 语义化版本号，传 aidToken 时必传 |
| appId | String | NO | App ID，传 aidToken 时必传 |
| username | String | NO | 用户名，关联字段 users->username不传则随机生成一个 6~8 位字符，需要避免使用禁用名（键名 ban_names 禁用值） |
| nickname | String | NO | 昵称，关联字段 users->nickname不传则随机生成一个 8 位字符 |
| password | String | NO | 登录密码，关联字段 users->password |
| avatarFid | String | NO | 头像 fid，存储时转换成 files->id关联字段 users->avatar_file_id |
| avatarUrl | String | NO | 头像 URL，关联字段 users->avatar_file_url |
| bannerFid | String | NO | 条幅图 fid，存储时转换成 files->id关联字段 users->banner_file_id |
| bannerUrl | String | NO | 条幅图 URL，关联字段 users->banner_file_url |
| gender | Number | NO | 性别，关联字段 users->gender |
| birthday | String | NO | 生日，关联字段 users->birthday，格式为 Y-m-d H:i:s |
结果示例
json
{
"code": 0,
"message": "ok",
"data": {
"aid": "accounts->aid",
"aidToken": "aidToken",
"uid": "users->uid",
"username": "users->username",
"nickname": "users->nickname"
}
}{
"code": 0,
"message": "ok",
"data": {
"aid": "accounts->aid",
"aidToken": "aidToken",
"uid": "users->uid",
"username": "users->username",
"nickname": "users->nickname"
}
}查看注册逻辑
- 注册时需要生成的数据清单
- 用户主表
users - 用户数据统计表
user_stats - 用户角色关联表
user_roles：初始角色来自配置表default_role键值。 - 其余传参有值时直接录入，无值时留空。
- 用户主表
校验用户
php
\FresnsCmdWord::plugin('Fresns')->verifyUser($wordBody);\FresnsCmdWord::plugin('Fresns')->verifyUser($wordBody);| 参数名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| platformId | Number | YES | 平台编号（配置表 platforms 键名的键值） |
| version | String | YES | 语义化版本号 |
| appId | String | YES | App ID |
| aid | String | YES | 账号 AID accounts->aid |
| aidToken | String | YES | 账号 Token |
| uid | Number | YES | 用户 UID users->uid |
| password | String | NO | 密码 users->password |
结果示例
json
{
"code": 0,
"message": "ok",
"data": {
"aid": "accounts->aid",
"aidToken": "aidToken",
"uid": "users->uid",
}
}{
"code": 0,
"message": "ok",
"data": {
"aid": "accounts->aid",
"aidToken": "aidToken",
"uid": "users->uid",
}
}创建用户凭证
php
\FresnsCmdWord::plugin('Fresns')->createUserToken($wordBody);\FresnsCmdWord::plugin('Fresns')->createUserToken($wordBody);| 参数名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| platformId | Number | YES | 平台编号（配置表 platforms 键名的键值） |
| version | String | YES | 语义化版本号 |
| appId | String | YES | App ID |
| aid | String | YES | 账号参数 session_tokens->account_id存储时由 aid 转换成 accounts->id |
| aidToken | String | YES | 账号身份凭证（凭证表 session_tokens->token 字段） |
| uid | Number | YES | 用户参数 session_tokens->user_id存储时由 uid 转换成 users->id |
| deviceToken | String | NO | 交互设备 Token 例如 iOS Device Token 或 Android Device Token 可应用于推送消息 |
| expiredTime | Number | NO | 过期时间，单位：小时（为空代表永久有效） |
结果示例
json
{
"code": 0,
"message": "ok",
"data": {
"aid": "aid",
"aidToken": "aidToken",
"uid": "users->uid",
"uidToken": "session_tokens->token",
"uidTokenId": "session_tokens->id",
"expiredHours": "有效期小时数", // 没有则输出 null
"expiredDays": "有效期天数", // 没有则输出 null
"expiredDateTime": "session_tokens->expired_at 留空代表永久有效，格式为 Y-m-d H:i:s", // 没有则输出 null
}
}{
"code": 0,
"message": "ok",
"data": {
"aid": "aid",
"aidToken": "aidToken",
"uid": "users->uid",
"uidToken": "session_tokens->token",
"uidTokenId": "session_tokens->id",
"expiredHours": "有效期小时数", // 没有则输出 null
"expiredDays": "有效期天数", // 没有则输出 null
"expiredDateTime": "session_tokens->expired_at 留空代表永久有效，格式为 Y-m-d H:i:s", // 没有则输出 null
}
}校验用户凭证
php
\FresnsCmdWord::plugin('Fresns')->verifyUserToken($wordBody);\FresnsCmdWord::plugin('Fresns')->verifyUserToken($wordBody);| 参数名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| platformId | Number | YES | 平台编号（配置表 platforms 键名的键值） |
| aid | String | YES | 账号参数 session_tokens->account_id查验时由 aid 转换成 accounts->id |
| aidToken | String | YES | 账号身份凭证（凭证表 session_tokens->token 字段） |
| uid | Number | YES | 用户参数 session_tokens->user_id查验时由 uid 转换成 users->id |
| uidToken | String | YES | 用户身份凭证（凭证表 session_tokens->token 字段） |
获取用户设备 Token
php
\FresnsCmdWord::plugin('Fresns')->getUserDeviceToken($wordBody);\FresnsCmdWord::plugin('Fresns')->getUserDeviceToken($wordBody);| 参数名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| uid | Number | YES | |
| platformId | Number | NO | 平台编号（配置表 platforms 键名的键值） 留空则输出全部 |
- 结果为数组列表，根据创建时间倒序排列，最新创建的在前面。
结果示例
json
{
"code": 0,
"message": "ok",
"data": [
{
"platformId": 5,
"deviceToken": "",
"datetime": ""
}
]
}{
"code": 0,
"message": "ok",
"data": [
{
"platformId": 5,
"deviceToken": "",
"datetime": ""
}
]
}逻辑删除用户
php
\FresnsCmdWord::plugin('Fresns')->logicalDeletionUser($wordBody);\FresnsCmdWord::plugin('Fresns')->logicalDeletionUser($wordBody);| 参数名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| uid | Number | YES | 用户 UID users->uid |
物理删除用户
php
\FresnsCmdWord::plugin('Fresns')->physicalDeletionUser($wordBody);\FresnsCmdWord::plugin('Fresns')->physicalDeletionUser($wordBody);| 参数名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| uid | Number | YES | 用户 UID users->uid |
- 物理删除涉及内容很多，所以删除功能使用队列执行，请配置 Fresns 队列。
设置用户扩展分值
php
\FresnsCmdWord::plugin('Fresns')->setUserExtcredits($wordBody);\FresnsCmdWord::plugin('Fresns')->setUserExtcredits($wordBody);| 参数名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| uid | Number | YES | 用户 UID users->uid |
| extcreditsId | Number | YES | extcredits id 1-5 |
| fskey | String | YES | 操作者 |
| operation | String | YES | 操作类型 increment 或 decrement |
| amount | Number | NO | 留空则默认为 1 |
| remark | String | NO | 备注 |
设置用户有效期
php
\FresnsCmdWord::plugin('Fresns')->setUserExpiryDatetime($wordBody);\FresnsCmdWord::plugin('Fresns')->setUserExpiryDatetime($wordBody);| 参数名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| uid | Number | YES | 用户 UID users->uid |
| datetime | String | NO | Y-m-d H:i:s 日期时间值，时区为数据库时区 |
| clearDatetime | Boolean | NO | 是否清空用户有效期 |
datetime和clearDatetime二选一传参。- 该功能仅对站点私有模式有效。
设置用户的小组有效期
php
\FresnsCmdWord::plugin('Fresns')->setUserGroupExpiryDatetime($wordBody);\FresnsCmdWord::plugin('Fresns')->setUserGroupExpiryDatetime($wordBody);| 参数名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| uid | Number | YES | 用户 UID users->uid |
| gid | String | YES | 小组 GID groups->gid |
| datetime | String | NO | Y-m-d H:i:s 日期时间值，时区为数据库时区 |
| clearDatetime | Boolean | NO | 是否清空用户有效期 |
datetime和clearDatetime二选一传参。- 该功能仅对小组私有模式有效。
- 如果用户未加入小组，则自动加入小组并设置有效期。
设置用户徽章
php
\FresnsCmdWord::plugin('Fresns')->setUserBadge($wordBody);\FresnsCmdWord::plugin('Fresns')->setUserBadge($wordBody);| 参数名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| uid | Number | YES | 用户 UID users->uid |
| fskey | String | YES | 插件 fskey |
| type | Number | YES | 1.红点 / 2.数字 / 3.文字 |
| badgeNumber | Number | NO | type=2 必传，显示的数字，如果有旧数字存在，则会累加 |
| badgeText | String | NO | type=3 必传，显示的文字内容，最长支持 8 字符 |
清除用户徽章
php
\FresnsCmdWord::plugin('Fresns')->clearUserBadge($wordBody);\FresnsCmdWord::plugin('Fresns')->clearUserBadge($wordBody);| 参数名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| uid | Number | YES | 用户 UID users->uid |
| fskey | String | YES | 插件 fskey |
清除用户所有徽章
php
\FresnsCmdWord::plugin('Fresns')->clearUserAllBadges($wordBody);\FresnsCmdWord::plugin('Fresns')->clearUserAllBadges($wordBody);| 参数名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| uid | Number | YES | 用户 UID users->uid |