wheniwork / oauth2-zenpayroll
ZenPayroll OAuth 2.0 Client Provider for The PHP League OAuth2-Client
v0.1.0
2015-02-27 17:29 UTC
Requires
- php: >=5.4.0
- league/oauth2-client: ~0.9.0
Requires (Dev)
- mockery/mockery: ~0.9
- phpunit/phpunit: ~4.0
This package is not auto-updated.
Last update: 2024-10-26 16:49:10 UTC
README
This package provides ZenPayroll OAuth 2.0 support for the PHP League's OAuth 2.0 Client.
Installation
To install, use composer:
composer require wheniwork/oauth2-zenpayroll
Usage
Usage is the same as The League's OAuth client, using Wheniwork\OAuth2\Client\Provider\Zenpayroll
as the provider.
Authorization Code Flow
$provider = new Wheniwork\OAuth2\Client\Provider\Zenpayroll([ 'clientId' => '{zenpayroll-client-id}', 'clientSecret' => '{zenpayroll-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->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->firstName); } 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
$provider = new Wheniwork\OAuth2\Client\Provider\Zenpayroll([ 'clientId' => '{zenpayroll-client-id}', 'clientSecret' => '{zenpayroll-client-secret}', 'redirectUri' => 'https://example.com/callback-url' ]); $grant = new \League\OAuth2\Client\Grant\RefreshToken(); $token = $provider->getAccessToken($grant, ['refresh_token' => $refreshToken]);