stevenmaguire/oauth2-dropbox

为PHP League OAuth2-Client提供的Dropbox OAuth 2.0客户端提供程序

3.1.0 2021-09-16 14:05 UTC

README

Latest Version Software License Build Status Coverage Status Quality Score Total Downloads

此软件包为PHP League的OAuth 2.0客户端提供Dropbox OAuth 2.0支持。

安装

要安装,请使用composer

composer require stevenmaguire/oauth2-dropbox

注意: 由于API已弃用,我们已停止对Dropbox API v1的支持。如果您需要使用v1,请使用^2.0.0版本约束

composer require "stevenmaguire/oauth2-dropbox:^2.0.0"

用法

用法与The League的OAuth客户端相同,使用\Stevenmaguire\OAuth2\Client\Provider\Dropbox作为提供程序。

授权码流

$provider = new Stevenmaguire\OAuth2\Client\Provider\Dropbox([
    'clientId'          => '{dropbox-client-id}',
    'clientSecret'      => '{dropbox-client-secret}',
    'redirectUri'       => 'https://example.com/callback-url'
]);

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->getId());

    } 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();
}

刷新令牌

Dropbox的OAuth实现不使用刷新令牌。访问令牌在用户手动撤销访问或应用自行取消授权之前有效。

测试

$ ./vendor/bin/phpunit

贡献

有关详细信息,请参阅CONTRIBUTING

致谢

许可

MIT许可证(MIT)。有关更多信息,请参阅许可文件