mediawiki/oauthclient

PHP OAuth client for use with Wikipedia and other MediaWiki-based wikis running the OAuth extension

![Latest Stable Version] ![License], _(*1)

mediawiki/oauthclient

PHP OAuth client for use with Wikipedia and other MediaWiki-based wikis running the OAuth extension., _(*2)

Installation

$ composer require mediawiki/oauthclient

Usage

For working example code, see the demo directory., _(*3)

General usage is as follows:, _(*4)

1. Create a new Client with consumer key that you've registered with the wiki. Setting an user agent is highly encouraged., _(*5)

   $conf = new ClientConfig( 'https://example.org/w/index.php?title=Special:OAuth' ); $conf->setConsumer( new Consumer( 'e331e186b64a938591e7614170814a75', '9b61abdfa2b88f05670af3919302b12bbc6a6e10' ) ); $conf->setUserAgent( 'MyCoolApp MediaWikiOAuthClient/1.0' ); $client = new Client( $conf );, _(*6)

2. Retrieve the authentication URL and the Request Token:, _(*7)

   list( $authUrl, $requestToken ) = $client->initiate();, _(*8)

3. Store the Request Token somewhere and send the user to the authentication URL., _(*9)

4. When the user comes back from the wiki they'll arrive at your callback URL, and the query string will contain an oauth_verifier key. Use this to retrieve an Acccess Token:, _(*10)

   $accessToken = $client->complete( $requestToken, $_GET['oauth_verifier'] );, _(*11)

5. Once you've got an Access Token you can store it and use it to make authenticated requests to the wiki., _(*12)

   To get the user's identity:, _(*13)

   $ident = $client->identify( $accessToken );, _(*14)

   To make any API call:, _(*15)

   $userInfo = $client->makeOAuthCall( $accessToken, "https://example.org/w/api.php?action=query&meta=userinfo&uiprop=rights&format=json" );, _(*16)

Running tests

composer install --prefer-dist
composer test

History

The code is a refactored version of Stype/mwoauth-php, which in turn is partially based on Andy Smith's OAuth library. Some code is taken from wikimedia/slimapp. See CHANGELOG.md for more details., _(*17)