README

此包为 PHP League 的 OAuth 2.0 客户端 提供了青年网 OAuth 2.0 支持。

安装

要安装，请使用 composer

composer require youthweb/oauth2-youthweb

使用方法

使用方法与 The League 的 OAuth 客户端相同，使用 \Youthweb\OAuth2\Client\Provider\Youthweb 作为提供者。

授权码流程

$provider = new Youthweb\OAuth2\Client\Provider\Youthweb([
    'clientId'          => '{youthweb-client-id}',
    'clientSecret'      => '{youthweb-client-secret}',
    'redirectUri'       => 'https://example.org/callback-url',
    'apiVersion'        => '0.15', // optional
]);

if ( ! isset($_GET['code']) )
{
    // If we don't have an authorization code then get one
    $authUrl = $provider->getAuthorizationUrl();
    $_SESSION['oauth2state'] = $provider->getState();
    header('Location: '.$authUrl);
    exit;
}
// Check given state against previously stored one to mitigate CSRF attack
elseif ( empty($_GET['state']) || ($_GET['state'] !== $_SESSION['oauth2state']) )
{
    unset($_SESSION['oauth2state']);
    exit('Invalid state');
}
else
{
    // Try to get an access token (using the authorization code grant)
    $token = $provider->getAccessToken('authorization_code', [
        'code' => $_GET['code']
    ]);

    // Optional: Now you have a token you can look up a users profile data
    try
    {
        // We got an access token, let's now get the user's details
        $user = $provider->getResourceOwner($token);

        // Use these details to create a new profile
        printf('Hello %s!', $user->getNickname());
    }
    catch (Exception $e)
    {
        // Failed to get user details
        exit('Oh dear...');
    }

    // Use this to interact with an API on the users behalf
    echo $token->getToken();
}

管理作用域

当创建青年网授权 URL 时，您可以指定应用程序可能授权的状态和作用域。

$options = [
    'state' => 'OPTIONAL_CUSTOM_CONFIGURED_STATE',
    'scope' => ['user:read', 'user:email'] // array or string
];

$authorizationUrl = $provider->getAuthorizationUrl($options);

如果没有定义，提供者将使用内部默认值。

在编写此文档时，以下作用域与青年网-API 0.15 一起可用

• post:read
• post:write
• user:read
• user:email

更多信息请参阅 此处。

测试

$ ./vendor/bin/phpunit

贡献

请随意分叉并发送 Pull Requests。此项目遵循 语义化版本控制 2 和 PSR-2。

致谢

• 所有贡献者

许可证

GPL3。请参阅 许可证文件 获取更多信息。