https://github.com/nagilum/oauth2-lib-for-php
OAuth2 implementation lib for PHP.
https://github.com/nagilum/oauth2-lib-for-php
Last synced: 3 months ago
JSON representation
OAuth2 implementation lib for PHP.
- Host: GitHub
- URL: https://github.com/nagilum/oauth2-lib-for-php
- Owner: nagilum
- Created: 2013-07-29T07:59:56.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2013-08-08T14:07:17.000Z (almost 12 years ago)
- Last Synced: 2025-01-16T13:47:44.989Z (4 months ago)
- Language: PHP
- Homepage:
- Size: 230 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# OAuth2 lib for PHP
I wrote this wrapper framework to make the login part of my other projects to a minimum.
Less code, me happy.
## Example of usage
```php
require_once 'OAuth2.php';
$client = new OAuth2\Client(
'your-apps-client-id',
'your-apps-client-secret',
'shorthand-provider-name',
'callback-uri-for-client'
);
if (!$client->is_authorized)
$client->authorize();
```
When you create a new instance of the class it will run through and try to retrieve an access token and user information if the authorization code has been provided.
When you call the `authorize()` function, you will be redirected to the provider's login page.
If you're already logged in, you might just get automatically redirected back to the callback URI.
Google requires that the callback URI is your-domain.com/oauth2callback, so you might as well use that for all providers.
When you have gained full authorization, the general user information will be stored in the `$client->user_info` and your private unique ID from the provider will be stored in `$client->unique_id`.
## Providers
Currently available providers in this library are:
[Bitly](http://dev.bitly.com/authentication.html),
[Facebook](https://developers.facebook.com/docs/),
[GitHub](http://developer.github.com/v3/),
[Google](http://code.google.com/more/),
[Live](http://msdn.microsoft.com/en-us/library/hh243647.aspx),
[Wordpress](http://developer.wordpress.com/docs/api/).
You can add more provider endpoints by adding an extra parameter when you initialize the class, like so:
```php
$client = new OAuth2\Client(
'your-apps-client-id',
'your-apps-client-secret',
'shorthand-provider-name',
'callback-uri-for-client',
'array-of-provider-endpoints'
);
```
The array must be formatted as such:
```php
$endpoints = array(
'provider-shorthand-name' => array(
OAUTH_URL_AUTH => 'url-for-oauth-authorization',
OAUTH_URL_TOKEN => 'url-for-oauth-access-token',
OAUTH_URL_USER => 'url-for-user-information',
),
);
```
Example of endpoints for Facebook:
```php
$endpoints = array(
'facebook' => array(
OAUTH_URL_AUTH => 'https://graph.facebook.com/oauth/authorize',
OAUTH_URL_TOKEN => 'https://graph.facebook.com/oauth/access_token',
OAUTH_URL_USER => 'https://graph.facebook.com/me',
),
);
```
## License
These libraries are released under the MIT license.
Copyright (c) 2013 Stian Hanger
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.