AbleCloud PHP SDK  1.8.x
PHP SDK of AbleCloud API
Public 成员函数 | 所有成员列表
ACAccountMgr类 参考
类 ACAccountMgr 继承关系图:
Inheritance graph
[图例]
ACAccountMgr 的协作图:
Collaboration graph
[图例]

Public 成员函数

 __construct ($name, $version, $context)
 
 changePhone ($user, $phone, $verifyCode, $password)
 
 changeNickName ($user, $nickName)
 
 updateUserToken ($user)
 
 resetPassword ($userId, $account, $password, $verifyCode)
 
 resetPasswordByAccount ($account, $password, $verifyCode)
 
 clearUsers ()
 
用户帐号注册与登录。
 getVerifyCode ($account, $timeout)
 
 sendVerifyCode ($account, $template, $timeout)
 
 checkVerifyCode ($account, $verifyCode)
 
 register ($name, $email, $phone, $password, $verifyCode, $enableTokenExpiration=FALSE)
 
 login ($account, $password, $enableTokenExpiration=FALSE)
 
 getUser ($account, $password, $enableTokenExpiration=FALSE)
 
 getAccountInfo ($userId)
 
 getIdByAccount ($account)
 
 checkAccountExist ($login)
 
 getAccountCount ()
 
 listAllAccounts ($offset, $limit)
 
 getAccountsByIds ($userIds)
 
第三方平台用户
 registerByOpenId ($openId, $provider, $unionId='', $enableTokenExpiration=FALSE)
 
 getUserByOpenId ($openId, $provider, $unionId='', $enableTokenExpiration=FALSE)
 
 getAccountByOpenId ($openId, $provider, $enableTokenExpiration=FALSE)
 
 getUserOpenId ($userId, $provider)
 
用户的扩展属性
 setUserProfile ($user, $profile)
 
 getUserProfile ($user)
 
 getUserWholeProfile ($uid=0, $account='')
 
 getProfilesByUserList ($userIds)
 
- Public 成员函数 继承自 ACService
 __construct ($name, $version, $context)
 
 getName ()
 
 getVersion ()
 
 getContext ()
 
 getLastError ()
 

额外继承的成员函数

- Protected 成员函数 继承自 ACService
 resetLastError ($errCode=0, $errMessage='')
 

详细描述

AbleCloud帐号服务。

构造及析构函数说明

◆ __construct()

ACAccountMgr::__construct (   $name,
  $version,
  $context 
)

构造函数。

参数
$namestring AbleCloud帐号服务的名字。
$versionint AbleCloud帐号服务的主版本号。
$contextACContext 表示访问该远程服务所依赖的环境信息。

成员函数说明

◆ changeNickName()

ACAccountMgr::changeNickName (   $user,
  $nickName 
)

修改用户显示名称。

参数
$userACUser 是要修改显示名的用户。
$nickNamestring 用户的新名字。
返回
bool 操作成功返回TRUE;操作失败则返回FALSE,并且可调用getLastError()方法获取错误信息。

◆ changePhone()

ACAccountMgr::changePhone (   $user,
  $phone,
  $verifyCode,
  $password 
)

修改用户的手机号码。

参数
$userACUser 是要修改手机号的用户。
$phonestring 字符串,是用户的新手机号码。
$verifyCodestring 是验证码。
$passwordstring 是用户的密码。
返回
bool 操作成功返回TRUE;操作失败则返回FALSE,并且可调用getLastError()方法获取错误信息。

◆ checkAccountExist()

ACAccountMgr::checkAccountExist (   $login)

检查帐号是否已经存在。

参数
$loginstring 表示用户的登录名,如邮箱或者手机号。
返回
bool 返回TRUE表示存在该帐号;不存在该帐号时返回FALSE;操作失败时也返回FALSE。 返回值为FALSE时,应该调用getLastError()方法获取错误信息,并检查其errCode值:errCode为0时,表示操作成功;否则表示操作失败。

◆ checkVerifyCode()

ACAccountMgr::checkVerifyCode (   $account,
  $verifyCode 
)

检查验证码是否有效。

参数
$accountstring 与验证码匹配的用户帐号:Email地址或者手机号码。
$verifyCodestring 待检查的验证码。
返回
bool 返回TRUE表示验证码有效,返回FALSE表示无效。返回NULL表示操作失败,此时可调用方法getLastError()获取错误信息。

◆ clearUsers()

ACAccountMgr::clearUsers ( )

清除已注册的帐号信息。仅测试环境支持该方法。

返回
bool 操作成功返回TRUE;否则返回FALSE,并且可调用getLastError()方法获取错误消息。

◆ getAccountByOpenId()

ACAccountMgr::getAccountByOpenId (   $openId,
  $provider,
  $enableTokenExpiration = FALSE 
)

◆ getAccountCount()

ACAccountMgr::getAccountCount ( )

检查用户的总数。

返回
int 返回用户总数。返回值小于0时表示操作失败,可调用getLastError()方法获取错误消息。

◆ getAccountInfo()

ACAccountMgr::getAccountInfo (   $userId)

根据用户的Id查找用户信息。

参数
$userIdint 用户的ID。
返回
ACUser | NULL 返回一个ACUser对象,表示该用户的信息。失败时返回NULL,并且可调用getLastError()方法获取错误消息。

◆ getAccountsByIds()

ACAccountMgr::getAccountsByIds (   $userIds)

依据用户的ID批量获取用户的帐号信息。

参数
$userIdsarray 拟查询的用户ID的列表。
返回
array 成功时返回ACUser对象的数组。失败时返回FALSE,并且可调用getLastError()方法获取错误消息。

◆ getIdByAccount()

ACAccountMgr::getIdByAccount (   $account)

根据电话或Email查找用户ID。

参数
$accountstring 待查询的用户的帐号:Email或者电话号码。
返回
int 查询成功时返回的用户ID为正整数。返回值小于0时表示查询失败,并且可调用getLastError()方法获取错误信息。

◆ getProfilesByUserList()

ACAccountMgr::getProfilesByUserList (   $userIds)

根据用户uid列表查找用户的信息(基本信息+扩展信息)。一次最多可查询1000个用户的信息。

参数
$userIdsarray 待查询的用户ID的数组。元素个数必须小于等于1000。
返回
array 操作成功时返回用户属性数据的数组。数组中的每个元素是一个关联数组,对应于一个用户的属性。操作失败时返回NULL,并且可调用getLastError()方法获取错误信息。

◆ getUser()

ACAccountMgr::getUser (   $account,
  $password,
  $enableTokenExpiration = FALSE 
)

按登录名和密码取用户的信息。

参数
$accountstring 用户的登录名。
$passwordstring 用户登录密码。
$enableTokenExpirationbool 是否使用用户TOKEN过期的机制。缺省为不使用。
返回
ACUser|NULL 返回一个ACUser对象,表示该用户的信息。失败时返回NULL,并且可调用getLastError()方法获取错误消息。

◆ getUserByOpenId()

ACAccountMgr::getUserByOpenId (   $openId,
  $provider,
  $unionId = '',
  $enableTokenExpiration = FALSE 
)

按OpenID和帐号来源取用户的信息。

参数
$openIdstring 用户的OpenID。
$providerstring 用户的来源。如"weixin"等。
$unionIdstring 对来自微信平台的用户,是其在微信平台对应的UnionID。
$enableTokenExpirationbool 是否使用用户TOKEN过期的机制。缺省为不使用。
返回
ACUser|NULL 返回一个ACUser对象,表示该用户的信息。失败时返回NULL,并且可调用getLastError()方法获取错误消息。

◆ getUserOpenId()

ACAccountMgr::getUserOpenId (   $userId,
  $provider 
)

获取用户在第三方平台上的OpenID。

参数
$userIdint 是用户在AbleCloud平台上的ID。
$providerstring 标识第三方平台。如'weixin'表示微信平台。
返回
string 返回一个字符串,表示用户在指定的第三方平台中对应的OpenID。如果返回值为空字符串,表示操作失败。此时,可调用getLastError()方法获取错误信息。

◆ getUserProfile()

ACAccountMgr::getUserProfile (   $user)

获取用户的扩展属性。

参数
$userACUser 表示要获取其扩展属性的用户。
返回
array|NULL 操作成功时返回一个由键值对组成的关联数组,表示该用户的扩展属性。操作失败时返回NULL,并且可调用getLastError()方法获取错误信息。

◆ getUserWholeProfile()

ACAccountMgr::getUserWholeProfile (   $uid = 0,
  $account = '' 
)

获取用户的全部属性:包括基础属性及扩展属性。

参数
$uidint 表示要获取其属性的用户的ID。参数$uid和$account至少需提供一个。
$accountstring 表示要获取其属性的用户的帐号名:Email地址或者电话。参数$uid和$account至少需提供一个。
返回
array|NULL 操作成功时返回一个由键值对组成的关联数组,表示该用户的属性。操作失败时返回NULL,并且可调用getLastError()方法获取错误信息。

◆ getVerifyCode()

ACAccountMgr::getVerifyCode (   $account,
  $timeout 
)

获取用户注册的验证码。

参数
$accountstring 是用户的登录名:email地址或手机号。
$timeoutint 是验证码的有效时长。单位为秒。
返回
string 操作成功时返回字符串形式的验证码。操作失败时返回空字符串,并且可以调用getLastError()方法获取错误信息。

◆ listAllAccounts()

ACAccountMgr::listAllAccounts (   $offset,
  $limit 
)

查询用户列表。

参数
$offsetint 查询的记录偏移量。取值应该为非负整数。
$limitint 限制本次调用查询的记录的最大数目。取值范围是闭区间[1, 100]。
返回
array 成功时返回ACUser对象的数组。失败时返回FALSE,并且可调用getLastError()方法获取错误消息。

◆ login()

ACAccountMgr::login (   $account,
  $password,
  $enableTokenExpiration = FALSE 
)

按登录名和密码登录,取用户的信息。

参数
$accountstring 用户的登录名。
$passwordstring 用户登录密码。
$enableTokenExpirationbool 是否使用用户TOKEN过期的机制。缺省为不使用。
返回
ACUser|NULL 返回一个ACUser对象,表示该用户的信息。失败时返回NULL,并且可调用getLastError()方法获取错误消息。

◆ register()

ACAccountMgr::register (   $name,
  $email,
  $phone,
  $password,
  $verifyCode,
  $enableTokenExpiration = FALSE 
)

注册用户帐号。

参数
$namestring 用户的显示名。
$emailstring 新用户的邮箱。$email与$phone不能都为空字符串。
$phonestring 新用户的手机号码。$email与$phone不能都为空字符串。
$passwordstring 新用户的登录密码。
$verifyCodestring 注册新用户时所使用的验证码。
$enableTokenExpirationbool 是否使用用户TOKEN过期的机制。缺省为不使用。
返回
ACUser|NULL 用户注册成功时返回一个ACUser对象,表示新用户的信息。失败时返回NULL,并且可调用getLastError()方法获取错误消息。

◆ registerByOpenId()

ACAccountMgr::registerByOpenId (   $openId,
  $provider,
  $unionId = '',
  $enableTokenExpiration = FALSE 
)

使用第三方帐号注册用户。

参数
$openIdstring 第三方帐号的OpenID。
$providerstring 第三方帐号的来源。如"weixin"。
$unionIdstring 对来自微信平台的用户,是其在微信平台对应的UnionID。如果不提供该参数,则无法识别同一个用户关注开发者的多个微信公众号的情况。
$enableTokenExpirationbool 是否使用用户TOKEN过期的机制。缺省为不使用。
返回
ACUser|NULL 注册成功后返回一个ACUser对象,表示新用户的信息。失败时返回NULL,并且可调用getLastError()方法获取错误消息。

◆ resetPassword()

ACAccountMgr::resetPassword (   $userId,
  $account,
  $password,
  $verifyCode 
)
弃用:
请使用resetPasswordByAccount方法。

重设用户的密码。

参数
$userIdint 要更新其密码的用户的ID。
$accountstring 要更新其密码的用户的登录名。
$passwordstring 用户的新密码。
$verifyCodestring 更新用户密码的验证码。
返回
bool 操作成功返回TRUE;操作失败则返回FALSE,并且可调用getLastError()方法获取错误信息。

◆ resetPasswordByAccount()

ACAccountMgr::resetPasswordByAccount (   $account,
  $password,
  $verifyCode 
)

重设用户的密码。

参数
$accountstring 要更新其密码的用户的登录名。
$passwordstring 用户的新密码。
$verifyCodestring 更新用户密码的验证码。
返回
bool 操作成功返回TRUE;操作失败则返回FALSE,并且可调用getLastError()方法获取错误信息。

◆ sendVerifyCode()

ACAccountMgr::sendVerifyCode (   $account,
  $template,
  $timeout 
)

向指定的手机号或电子邮箱发送验证码。

参数
$accountstring 接收验证码的手机号或电子邮箱地址。
$templateint 是短信模板的代码。
$timeoutint 是验证码的有效时长,单位是秒。
返回
bool 操作成功时返回TRUE;操作失败时返回FALSE,并且可调用getLastError()后去错误信息。

◆ setUserProfile()

ACAccountMgr::setUserProfile (   $user,
  $profile 
)

设置用户的扩展属性。

参数
$userACUser ACUser对象,表示要设置其扩展属性的用户。
$profilearray 是由键值对组成的关联数组,表示用户的扩展属性值。
返回
bool 操作成功时返回TRUE,否则返回FALSE。操作失败时可以调用getLastError()方法获取错误信息。

◆ updateUserToken()

ACAccountMgr::updateUserToken (   $user)

更新用户的Token。

参数
$userACUser 要更新其Token的用户。操作成功后直接更新该对象保存的信息。
返回
bool 返回TRUE表示操作成功,并且会更新$user对象的信息;返回FALSE表示操作失败,可以调用getLassError()获取错误信息。

该类的文档由以下文件生成: