2013-03-25 16:59:42 +04:00
|
|
|
# OAuth 2.0 Client Library
|
2013-03-15 15:26:41 +04:00
|
|
|
|
2013-11-18 06:18:23 +04:00
|
|
|
[![Build Status](https://travis-ci.org/php-loep/oauth2-client.png?branch=master)](https://travis-ci.org/php-loep/oauth2-client)
|
|
|
|
[![Total Downloads](https://poser.pugx.org/league/oauth2-client/downloads.png)](https://packagist.org/packages/league/oauth2-client)
|
|
|
|
[![Latest Stable Version](https://poser.pugx.org/league/oauth2-client/v/stable.png)](https://packagist.org/packages/league/oauth2-client)
|
|
|
|
|
2013-03-25 16:59:42 +04:00
|
|
|
This library makes it stupidly simple to integrate your application with OAuth 2.0 identity providers. It has built in support for:
|
2013-03-15 15:26:41 +04:00
|
|
|
|
2013-03-25 16:59:42 +04:00
|
|
|
* Facebook
|
|
|
|
* Github
|
|
|
|
* Google
|
2013-08-22 03:08:28 +04:00
|
|
|
* Instagram
|
|
|
|
* LinkedIn
|
2013-08-23 06:52:00 +04:00
|
|
|
* Microsoft
|
2013-11-14 11:40:10 +04:00
|
|
|
* Vkontakte
|
2013-03-15 15:26:41 +04:00
|
|
|
|
2013-03-25 16:59:42 +04:00
|
|
|
Adding support for other providers is trivial.
|
|
|
|
|
|
|
|
The library requires PHP 5.3+ and is PSR-0 compatible.
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
```php
|
2013-08-21 02:10:28 +04:00
|
|
|
$provider = new League\OAuth2\Client\Provider\<provider name>(array(
|
2013-03-25 16:59:42 +04:00
|
|
|
'clientId' => 'XXXXXXXX',
|
|
|
|
'clientSecret' => 'XXXXXXXX',
|
|
|
|
'redirectUri' => 'http://your-registered-redirect-uri/'
|
|
|
|
));
|
|
|
|
|
|
|
|
if ( ! isset($_GET['code'])) {
|
|
|
|
|
|
|
|
// If we don't have an authorization code then get one
|
|
|
|
$provider->authorize();
|
|
|
|
|
|
|
|
} else {
|
|
|
|
|
|
|
|
try {
|
|
|
|
|
|
|
|
// Try to get an access token (using the authorization code grant)
|
|
|
|
$t = $provider->getAccessToken('authorization_code', array('code' => $_GET['code']));
|
|
|
|
|
|
|
|
try {
|
|
|
|
|
|
|
|
// We got an access token, let's now get the user's details
|
|
|
|
$userDetails = $provider->getUserDetails($t);
|
|
|
|
|
|
|
|
foreach ($userDetails as $attribute => $value) {
|
|
|
|
var_dump($attribute, $value) . PHP_EOL . PHP_EOL;
|
|
|
|
}
|
|
|
|
|
|
|
|
} catch (Exception $e) {
|
|
|
|
|
|
|
|
// Failed to get user details
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
} catch (Exception $e) {
|
|
|
|
|
|
|
|
// Failed to get access token
|
|
|
|
|
|
|
|
}
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
### List of built-in identity providers
|
|
|
|
|
|
|
|
| Provider | uid | nickname | name | first_name | last_name | email | location | description | imageUrl | urls |
|
|
|
|
| :------- | :----- | :------- | :----- | :--------- | :-------- | :----- | :------- | :---------- | :------- | :--- |
|
|
|
|
| **Facebook** | string | string | string | string | string | string | string | string | string | array (Facebook) |
|
|
|
|
| **Github** | string | string | string | null | null | string | null | null | null | array (Github, [personal])|
|
|
|
|
| **Google** | string | string | string | string | string | string | null | null | string | null |
|
2013-08-21 02:10:28 +04:00
|
|
|
| **Instagram** | string | string | string | null | null | null | null | string | string | null |
|
2013-08-22 03:08:28 +04:00
|
|
|
| **LinkedIn** | string | null | string | null | null | string | string | string | string | string |
|
2013-08-23 06:52:00 +04:00
|
|
|
| **Microsoft** | string | null | string | string | string | string | null | null | string | string |
|
2013-03-15 15:26:41 +04:00
|
|
|
|
2013-08-21 02:10:28 +04:00
|
|
|
**Notes**: Providers which return URLs sometimes include additional URLs if the user has provided them. These have been wrapped in []
|