Skip to content
On this page

User Command Word

addUser

php
\FresnsCmdWord::plugin('Fresns')->addUser($wordBody)
Parameter NameTypeRequiredDescription
aidStringrequired关联字段 accounts > aid
aidTokenStringoptional不传则不验证账号身份,直接为该账号添加用户
platformIdNumberoptional平台编号,传 aidToken 时必传
versionStringoptional语义化版本号,传 aidToken 时必传
appIdStringoptionalApp ID,传 aidToken 时必传
nicknameStringrequired昵称,关联字段 users > nickname
usernameStringoptional用户名,关联字段 users > username
不传则随机生成一个 6~8 位字符,需要避免使用禁用名(键名 ban_names 禁用值)
passwordStringoptional登录密码,关联字段 users > password
avatarFidStringoptional头像 fid,存储时转换成 files > id
关联字段 users > avatar_file_id
avatarUrlStringoptional头像 URL,关联字段 users > avatar_file_url
如果留空,则判断 avatarFid 是否也留空,如果有值,则凭 fid 获取 url 入库(忽略防盗链,仅拼接地址)
genderNumberoptional性别,关联字段 users > gender
birthdayStringoptional生日,关联字段 users > birthday,格式为 Y-m-d H:i:s
timezoneStringoptional偏好时区,关联字段 users > timezone
languageStringoptional偏好语言,关联字段 users > language
Return Example
json
{
    "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 键值。
    • 其余传参有值时直接录入,无值时留空。
  • 注册完成后,增加数据统计。配置表键值 users_count +1

verifyUser

php
\FresnsCmdWord::plugin('Fresns')->verifyUser($wordBody)
Parameter NameTypeRequiredDescription
platformIdNumberrequired平台编号(配置表 platforms 键名的键值)
versionStringrequired语义化版本号
appIdStringrequiredApp ID
aidStringrequired账号 AID accounts > aid
aidTokenStringrequired账号 Token
uidNumberrequired用户 UID users > uid
passwordStringoptional密码 users > password
Return Example
json
{
    "code": 0,
    "message": "ok",
    "data": {
        "aid": "accounts > aid",
        "aidToken": "aidToken",
        "uid": "users > uid",
    }
}

createUserToken

php
\FresnsCmdWord::plugin('Fresns')->createUserToken($wordBody)
Parameter NameTypeRequiredDescription
platformIdNumberrequired平台编号(配置表 platforms 键名的键值)
versionStringrequired语义化版本号
appIdStringrequiredApp ID
aidStringrequired账号参数 session_tokens > account_id
存储时由 aid 转换成 accounts > id
aidTokenStringrequired账号身份凭证(凭证表 session_tokens > token 字段)
uidNumberrequired用户参数 session_tokens > user_id
存储时由 uid 转换成 users > id
expiredTimeNumberoptional过期时间,单位:小时(为空代表永久有效)
Return Example
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
    }
}

verifyUserToken

php
\FresnsCmdWord::plugin('Fresns')->verifyUserToken($wordBody)
Parameter NameTypeRequiredDescription
platformIdNumberrequired平台编号(配置表 platforms 键名的键值)
versionStringrequired语义化版本号
appIdStringrequiredApp ID
aidStringrequired账号参数 session_tokens > account_id
查验时由 aid 转换成 accounts > id
aidTokenStringrequired账号身份凭证(凭证表 session_tokens > token 字段)
uidNumberrequired用户参数 session_tokens > user_id
查验时由 uid 转换成 users > id
uidTokenStringrequired用户身份凭证(凭证表 session_tokens > token 字段)

logicalDeletionUser

php
\FresnsCmdWord::plugin('Fresns')->logicalDeletionUser($wordBody)
Parameter NameTypeRequiredDescription
uidNumberoptional用户 UID users > uid

Released under the Apache-2.0 License