README

Authing PHP SDK 由两部分组成：ManagementClient 和 AuthenticationClient。ManagementClient 中进行的所有操作均以管理员的身份进行，包含管理用户、管理角色、管理权限策略、管理用户池配置等模块。AuthenticationClient 中的所有操作以当前终端用户的身份进行，包含登录、注册、修改用户资料、退出登录等方法。

你应该将初始化过后的 ManagementClient 实例设置为一个全局变量（只初始化一次），而 AuthenticationClient 应该每次请求初始化一个。

安装

我们推荐使用 composer 进行安装，它可以与一些模块打包工具很好地配合使用。

# latest stable
$ composer require authing-sdk/php-72

使用管理模块

初始化 ManagementClient 需要 userPoolId（用户池 ID）和 secret（用户池密钥）:

你可以在此了解如何获取 UserPoolId 和 Secret .

use Authing\Mgmt\ManagementClient;

$management = new ManagementClient("AUTHING_USERPOOL_ID", "AUTHING_USERPOOL_SECRET");
// 获取管理员权限
$management->requestToken();

现在 managementClient 实例就可以使用了。例如可以获取用户池中的用户列表：

use Authing\Mgmt\ManagementClient;

$management = new ManagementClient("AUTHING_USERPOOL_ID", "AUTHING_USERPOOL_SECRET");
// 获取管理员权限
$management->requestToken();
$users = $management->users()->paginate();

使用认证模块

初始化 AuthenticationClient 需要 appId（应用 ID）：

你可以在此了解如何获取 AppId .

use Authing\Auth\AuthenticationClient;

$authentication = new AuthenticationClient(function ($ops) {
    $ops->appId = "---";
});

接下来可以进行注册登录等操作：

use Authing\Auth\AuthenticationClient;
use Authing\Types\LoginByEmailInput;

$authentication = new AuthenticationClient(function ($ops) {
    $ops->appId = "---";
});
$user = $authentication->loginByEmail(new LoginByEmailInput("test@example.com", "123456"));

完成登录之后，update_profile 等要求用户登录的方法就可用了：

use Authing\Auth\AuthenticationClient;
use Authing\Types\LoginByEmailInput;
use Authing\Types\UpdateUserInput;

$authentication = new AuthenticationClient(function ($ops) {
    $ops->appId = "---";
});
$authentication->loginByEmail(new LoginByEmailInput("test@example.com", "123456"));

$user = $authentication->updateProfile((new UpdateUserInput())->withNickname("nickname"));

你也可以在初始化后设置 AccessToken 参数, 不需要每次都调用 LoginByXXX 方法:

use Authing\Auth\AuthenticationClient;

$authentication = new AuthenticationClient(function ($ops) {
    $ops->appId = "---";
});
$authentication->setAccessToken("ACCESS_TOKEN");

再次执行 UpdateProfile 方法，发现也成功了:

use Authing\Auth\AuthenticationClient;
use Authing\Types\UpdateUserInput;

$authentication = new AuthenticationClient(function ($ops) {
    $ops->appId = "---";
});
$authentication->setAccessToken("ACCESS_TOKEN");

$user = $authentication->updateProfile((new UpdateUserInput())->withNickname("nickname"));

错误处理

统一使用 try catch 处理：

use Authing\Auth\AuthenticationClient;
use Authing\Types\UpdateUserInput;

$authentication = new AuthenticationClient("AUTHING_USERPOOL_ID");
$authentication->setAccessToken("ACCESS_TOKEN");

try {
    $user = $authentication->updateProfile((new UpdateUserInput())->withNickname("nickname"));
} catch (Exception $e) {
    print_r($e);
}