martin1982 / oauth2-soundcloud
SoundCloud Oauth 2.0 Client Provider for The PHP League OAuth2-Client
Installs: 2 993
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Requires
- php: >=8.0
- league/oauth2-client: ^2.3
Requires (Dev)
- ext-json: *
- friendsofphp/php-cs-fixer: ^3.0
- php-parallel-lint/php-console-highlighter: ^1.0
- php-parallel-lint/php-parallel-lint: ^1.0
- phpmd/phpmd: ^2.10
- phpstan/phpstan: ^1.9
- phpunit/phpunit: ^9.5
- squizlabs/php_codesniffer: ^3.5
- symfony/var-dumper: ^4.4|^5.4|^6.0
README
SoundCloud Provider for OAuth 2.0 Client
This package provides SoundCloud OAuth 2.0 support for the PHP League's OAuth 2.0 Client.
Installation
You can install this package using Composer:
composer require martin1982/oauth2-soundcloud
You will then need to:
- run
composer install
to get these dependencies added to your vendor directory - add the autoloader to your application with this line:
require('vendor/autoload.php');
Usage
Usage is the same as The League's OAuth client, using \Martin1982\OAuth2\Client\Provider\SoundCloud
as the provider.
Authorization Code Flow
$provider = new Martin1982\OAuth2\Client\Provider\SoundCloud([ 'clientId' => '{soundcloud-client-id}', 'clientSecret' => '{soundcloud-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']); 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 \Martin1982\OAuth2\Client\Provider\SoundCloudResourceOwner $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>';
Credits
- Based on oauth2-deezer by Julien Bornstein
License
The MIT License (MIT). Please see License File for more information.