rhosocial/yii2-oauth2client

Rho Social OAuth 2 Client for Yii 2 Web Applications.

dev-master 2015-09-20 05:04 UTC

Requires

• php: >=5.4.0
• yiisoft/yii2: *
• yiisoft/yii2-authclient: *

BSD-3-Clause

• rhosocial

• client
• oauth2
• extension
• social
• yii2
• rho

README

Rho Social OAuth 2 Client for Yii 2 Web Applications. This extension is currently under development. Please do not download, fork or use this extension if you didn't obtained the test invitation, and we temprarily do not accept the pull requests.

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist rhosocial/yii2-oauth2client "*"

or add

"rhosocial/yii2-oauth2client": "*"

to the require section of your composer.json file.

Usage

Attach the Auth Action to Controller:

class SiteController extends Controller
{
    public function actions()
    {
        return [
            'auth' => [
                'class' => 'rhosocial\Oauth2Client\AuthAction',
                'successCallback' => [$this, 'onAuthSuccess'],
            ],
        ]
    }
    public function onAuthSuccess($client)
    {
        $attributes = $client->getUserAttributes();
        // user login or signup comes here
    }
}

Attach the following code to the Component section of main configuration:

'authClientCollection' => [
    'class' => 'yii\authclient\Collection',
    'clients' => [
        'rho_social' => [
            'class' => 'rhosocial\Oauth2client\Oauth2client',
            'clientId' => <client id>,
            'clientSecret' => <client secret>,
        ],
    ],
],

Please replace the <client id> and <client secret> with what assigned for you.

Then use the AuthChoice Widget in your login view, insert the following code into where you want:

<?= yii\authclient\widgets\AuthChoice::widget([
    'baseAuthUrl' => ['site/auth'],
    'popupMode' => true,
]);?>

If you didn't choose the 'site/auth' as your Auth Action, please modify the 'baseAuthUrl' property to the actual route.

Contact Us

If you have any problems or good ideas about yii2-oauth2client, please discuss there, or send an email to [e-mail]. Thank you!

If you want to send an email with your issues, please briefly introduce yourself first, for instance including your title and github homepage.