julienbornstein/oauth2-deezer

The PHP League OAuth2-Client 的 Deezer Oauth 2.0 客户端提供者

0.1.4 2024-05-02 12:11 UTC

This package is auto-updated.

Last update: 2024-09-02 18:13:09 UTC


README

PHP version GitHub Workflow Status Codecov Total Downloads Latest Stable Version License

Deezer OAuth 2.0 客户端提供者

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

安装

您可以使用 Composer 安装此软件包

composer require julienbornstein/oauth2-deezer

然后,您需要

  • 运行 composer install 以将这些依赖项添加到您的 vendor 目录
  • 使用此行将自动加载器添加到您的应用程序中: require('vendor/autoload.php');

使用方法

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

授权码流

$provider = new ParisBouge\OAuth2\Client\Provider\Deezer([
    'clientId'     => '{deezer-client-id}',
    'clientSecret' => '{deezer-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([
        'scope' => [
            ParisBouge\OAuth2\Client\Provider\Deezer::SCOPE_BASIC_ACCESS,
            ParisBouge\OAuth2\Client\Provider\Deezer::SCOPE_EMAIL,
        ]
    ]);
    
    $_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']);
    echo 'Invalid state.';
    exit;

}

// 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
    /** @var \ParisBouge\OAuth2\Client\Provider\DeezerResourceOwner $user */
    $user = $provider->getResourceOwner($token);

    // Use these details to create a new profile
    printf('Hello %s!', $user->getFirstname());
    
    echo '<pre>';
    var_dump($user);
    echo '</pre>';

} catch (Exception $e) {

    // Failed to get user details
    exit('Damned...');
}

echo '<pre>';
// Use this to interact with an API on the users behalf
var_dump($token->getToken());
# string(217) "CAADAppfn3msBAI7tZBLWg...

// The time (in epoch time) when an access token will expire
var_dump($token->getExpires());
# int(1436825866)
echo '</pre>';

授权范围

以下范围如官方文档中所述可用: 官方文档

  • SCOPE_BASIC_ACCESS
  • SCOPE_EMAIL
  • SCOPE_OFFLINE_ACCESS
  • SCOPE_MANAGE_LIBRARY
  • SCOPE_MANAGE_COMMUNITY
  • SCOPE_DELETE_LIBRARY
  • SCOPE_LISTENING_HISTORY

贡献

请参阅 CONTRIBUTING 了解详细信息。

致谢

许可证

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