File size: 3.74Kb
PHPoAuthLib
===========
PHPoAuthLib provides oAuth support in PHP 7.2+ and 8.0+. It's very easy to integrate with any project which requires an oAuth client.
[](https://scrutinizer-ci.com/g/carlos-mg89/PHPoAuthLib/build-status/master)
[](https://scrutinizer-ci.com/g/carlos-mg89/PHPoAuthLib/)
[](https://scrutinizer-ci.com/g/carlos-mg89/PHPoAuthLib/)
[](https://packagist.org/packages/carlos-mg89/oauth)
[](https://packagist.org/packages/carlos-mg89/oauth)
Installation
------------
This library can be found on [Packagist](https://packagist.org/packages/carlos-mg89/oauth).
The recommended way to install this is through [composer](http://getcomposer.org).
```bash
composer require carlos-mg89/oauth
```
Features
--------
- PSR-4
- Fully extensible in every facet.
- You can implement any service with any custom requirements by extending the protocol version's `AbstractService` implementation.
- You can use any HTTP client you desire, just create a class utilizing it which implements `OAuth\Common\Http\ClientInterface` (two implementations are included)
- You can use any storage mechanism for tokens. By default, session, in-memory and Redis.io (requires PHPRedis) storage mechanisms are included. Implement additional mechanisms by implementing `OAuth\Common\Token\TokenStorageInterface`.
Service support
---------------
The library supports both oAuth 1.x and oAuth 2.0 compliant services. A list of currently implemented services can be found below.
Included service implementations
--------------------------------
- OAuth1
- 500px
- BitBucket
- Etsy
- FitBit
- Flickr
- QuickBooks
- Scoop.it!
- Tumblr
- Twitter
- Yahoo
- OAuth2
- Amazon
- BitLy
- Bitrix24
- Box
- Buffer
- Dailymotion
- Delicious
- Deezer
- DeviantArt
- Dropbox
- Eve Online
- Facebook
- Foursquare
- GitHub
- Google
- Harvest
- Heroku
- Hubic
- Instagram
- Jawbone UP
- LinkedIn
- Mailchimp
- Microsoft
- Mondo
- Nest
- Netatmo
- Parrot Flower Power
- PayPal
- Pinterest
- Pocket
- Reddit
- RunKeeper
- Salesforce
- SoundCloud
- Spotify
- Strava
- Stripe
- Ustream
- Vimeo
- Vkontakte
- Xing
- Yahoo
- Yammer
- more to come!
Examples
--------
```bash
php -S localhost:8000 -t examples
```
Then point your browser to:
```text
http://localhost:8000/
```
Usage
------
For usage with complete auth flow, please see the examples. More in-depth documentation will come with release 1.0.
Framework Integration
---------------------
* Lithium: Sébastien Charrier has written [an adapter](https://github.com/scharrier/li3_socialauth) for the library.
* Laravel 4: Dariusz Prząda has written [a service provider](https://github.com/artdarek/oauth-4-laravel) for the library.
* Laravel 5: Valentin Ivaşcu ported Dariusz Prząda's Laravel 4 library to [Laravel 5](https://github.com/oriceon/oauth-5-laravel).
* Symfony: Alexander Pinnecke has written [a Symfony Bundle](https://github.com/apinnecke/OAuthBundle) for the library.
Extensions
----------
* Extract normalized user data from OAuth Services with the library [PHPoAuthUserData](https://github.com/Oryzone/PHPoAuthUserData) by Luciano Mammino
Tests
------
```bash
composer tests
```