[Summary view] [Print] [Text view]

   1  PHPoAuthLib
   2  ===========
   3  
   4  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.
   5  
   6  [![Build Status](https://scrutinizer-ci.com/g/carlos-mg89/PHPoAuthLib/badges/build.png?b=master)](https://scrutinizer-ci.com/g/carlos-mg89/PHPoAuthLib/build-status/master)
   7  [![Code Coverage](https://scrutinizer-ci.com/g/carlos-mg89/PHPoAuthLib/badges/coverage.png?s=master)](https://scrutinizer-ci.com/g/carlos-mg89/PHPoAuthLib/)
   8  [![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/carlos-mg89/PHPoAuthLib/badges/quality-score.png?s=master)](https://scrutinizer-ci.com/g/carlos-mg89/PHPoAuthLib/)
   9  [![Latest Stable Version](https://poser.pugx.org/carlos-mg89/oauth/v/stable.png)](https://packagist.org/packages/carlos-mg89/oauth)
  10  [![Total Downloads](https://poser.pugx.org/carlos-mg89/oauth/downloads.png)](https://packagist.org/packages/carlos-mg89/oauth)
  11  
  12  Installation
  13  ------------
  14  This library can be found on [Packagist](https://packagist.org/packages/carlos-mg89/oauth).
  15  The recommended way to install this is through [composer](http://getcomposer.org).
  16  
  17  
  18  ```bash
  19      composer require carlos-mg89/oauth
  20  ```
  21  
  22  Features
  23  --------
  24  - PSR-4 
  25  - Fully extensible in every facet.
  26      - You can implement any service with any custom requirements by extending the protocol version's `AbstractService` implementation.
  27      - You can use any HTTP client you desire, just create a class utilizing it which implements `OAuth\Common\Http\ClientInterface` (two implementations are included)
  28      - 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`.
  29  
  30  Service support
  31  ---------------
  32  The library supports both oAuth 1.x and oAuth 2.0 compliant services. A list of currently implemented services can be found below.
  33  
  34  Included service implementations
  35  --------------------------------
  36  - OAuth1
  37      - 500px
  38      - BitBucket
  39      - Etsy
  40      - FitBit
  41      - Flickr
  42      - QuickBooks
  43      - Scoop.it!
  44      - Tumblr
  45      - Twitter
  46      - Yahoo
  47  - OAuth2
  48      - Amazon
  49      - BitLy
  50      - Bitrix24
  51      - Box
  52      - Buffer
  53      - Dailymotion
  54      - Delicious
  55      - Deezer
  56      - DeviantArt
  57      - Dropbox
  58      - Eve Online
  59      - Facebook
  60      - Foursquare
  61      - GitHub
  62      - Google
  63      - Harvest
  64      - Heroku
  65      - Hubic
  66      - Instagram
  67      - Jawbone UP
  68      - LinkedIn
  69      - Mailchimp
  70      - Microsoft
  71      - Mondo
  72      - Nest
  73      - Netatmo
  74      - Parrot Flower Power
  75      - PayPal
  76      - Pinterest
  77      - Pocket
  78      - Reddit
  79      - RunKeeper
  80      - Salesforce
  81      - SoundCloud
  82      - Spotify
  83      - Strava
  84      - Stripe
  85      - Ustream
  86      - Vimeo
  87      - Vkontakte
  88      - Xing
  89      - Yahoo
  90      - Yammer
  91  - more to come!
  92  
  93  Examples
  94  --------
  95  ```bash
  96      php -S localhost:8000 -t examples
  97  ```
  98  Then point your browser to:
  99  ```text
 100      http://localhost:8000/
 101  ```
 102  
 103  
 104  Usage
 105  ------
 106  For usage with complete auth flow, please see the examples. More in-depth documentation will come with release 1.0.
 107  
 108  Framework Integration
 109  ---------------------
 110  * Lithium: Sébastien Charrier has written [an adapter](https://github.com/scharrier/li3_socialauth) for the library.
 111  * Laravel 4: Dariusz Prząda has written [a service provider](https://github.com/artdarek/oauth-4-laravel) for the library.
 112  * Laravel 5: Valentin Ivaşcu ported Dariusz Prząda's Laravel 4 library to [Laravel 5](https://github.com/oriceon/oauth-5-laravel).
 113  * Symfony: Alexander Pinnecke has written [a Symfony Bundle](https://github.com/apinnecke/OAuthBundle) for the library.
 114  
 115  Extensions
 116  ----------
 117  * Extract normalized user data from OAuth Services with the library [PHPoAuthUserData](https://github.com/Oryzone/PHPoAuthUserData) by Luciano Mammino
 118  
 119  Tests
 120  ------
 121  ```bash
 122      composer tests
 123  ```