Name: oauth2-github
Owner: The League of Extraordinary Packages
Description: GitHub Provider for the OAuth 2.0 Client
Created: 2015-04-13 14:33:43.0
Updated: 2018-04-29 05:24:42.0
Pushed: 2018-03-29 12:58:57.0
Homepage: null
Size: 27
Language: PHP
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
This package provides Github OAuth 2.0 support for the PHP League's OAuth 2.0 Client.
To install, use composer:
oser require league/oauth2-github
Usage is the same as The League's OAuth client, using \League\OAuth2\Client\Provider\Github as the provider.
vider = new League\OAuth2\Client\Provider\Github([
'clientId' => '{github-client-id}',
'clientSecret' => '{github-client-secret}',
'redirectUri' => 'https://example.com/callback-url',
!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;
heck given state against previously stored one to mitigate CSRF attack
seif (empty($_GET['state']) || ($_GET['state'] !== $_SESSION['oauth2state'])) {
unset($_SESSION['oauth2state']);
exit('Invalid state');
se {
// 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->getNickname());
} 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();
When creating your Github authorization URL, you can specify the state and scopes your application may authorize.
ions = [
'state' => 'OPTIONAL_CUSTOM_CONFIGURED_STATE',
'scope' => ['user','user:email','repo'] // array or string
horizationUrl = $provider->getAuthorizationUrl($options);
If neither are defined, the provider will utilize internal defaults.
At the time of authoring this documentation, the following scopes are available.
vendor/bin/phpunit
Please see CONTRIBUTING for details.
The MIT License (MIT). Please see License File for more information.