Skip to content

wheniwork/oauth2-clover

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Clover Provider for OAuth 2.0 Client

Build Status Code Coverage Code Quality License Latest Stable Version

This package provides Clover OAuth 2.0 support for the PHP League's OAuth 2.0 Client.

Installation

To install, use composer:

composer require wheniwork/oauth2-clover

Usage

Usage is the same as The League's OAuth client, using Wheniwork\OAuth2\Client\Provider\Clover as the provider.

Authorization Code Flow

$provider = new Wheniwork\OAuth2\Client\Provider\Clover([
    'clientId'     => '{clover-client-id}',
    'clientSecret' => '{clover-client-secret}',
    'marketPrefix' => '{clover-market-prefix}',
    '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->state;
    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
        $userDetails = $provider->getUserDetails($token);

        // Use these details to create a new profile
        printf('Hello %s!', $userDetails->name);

    } catch (Exception $e) {

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

    // Use this to interact with an API on the users behalf
    echo $token->accessToken;

}

Refreshing a Token

Clover does not use refresh tokens.

About

Clover provider for the OAuth 2.0 Client

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages