README

Module for management users and their rights with the support of registration via social services and assigned to each user more than one social service.

Abilities

User registration and authorization by e-mail and via social networks with the ability to bind several different social networking accounts to a one account on the your site

Changing password

Recovering password

Changing e-mail. Confirmation will be sent to the old and new address

Editinig profile

Administation module for manage users

Editing RBAC structure and user rights via the GUI

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist budyaga/yii2-users "*"

or add

"budyaga/yii2-users": "*"

to the require section of your composer.json file.

Config

'user' => [
    'identityClass' => 'budyaga\users\models\User',
    'enableAutoLogin' => true,
    'loginUrl' => ['/login'],
],
'authClientCollection' => [
    'class' => 'yii\authclient\Collection',
    'clients' => [
        'vkontakte' => [
            'class' => 'budyaga\users\components\oauth\VKontakte',
            'clientId' => 'XXX',
            'clientSecret' => 'XXX',
            'scope' => 'email'
        ],
        'google' => [
            'class' => 'budyaga\users\components\oauth\Google',
            'clientId' => 'XXX',
            'clientSecret' => 'XXX',
        ],
        'facebook' => [
            'class' => 'budyaga\users\components\oauth\Facebook',
            'clientId' => 'XXX',
            'clientSecret' => 'XXX',
        ],
        'github' => [
            'class' => 'budyaga\users\components\oauth\GitHub',
            'clientId' => 'XXX',
            'clientSecret' => 'XXX',
            'scope' => 'user:email, user'
        ],
        'linkedin' => [
            'class' => 'budyaga\users\components\oauth\LinkedIn',
            'clientId' => 'XXX',
            'clientSecret' => 'XXX',
        ],
        'live' => [
            'class' => 'budyaga\users\components\oauth\Live',
            'clientId' => 'XXX',
            'clientSecret' => 'XXX',
        ],
        'yandex' => [
            'class' => 'budyaga\users\components\oauth\Yandex',
            'clientId' => 'XXX',
            'clientSecret' => 'XXX',
        ],
        'twitter' => [
            'class' => 'budyaga\users\components\oauth\Twitter',
            'consumerKey' => 'XXX',
            'consumerSecret' => 'XXX',
        ],
    ],
],
'urlManager' => [
    'enablePrettyUrl' => true,
    'showScriptName' => false,
    'rules' => [
        '/signup' => '/user/user/signup',
        '/login' => '/user/user/login',
        '/logout' => '/user/user/logout',
        '/requestPasswordReset' => '/user/user/request-password-reset',
        '/resetPassword' => '/user/user/reset-password',
        '/profile' => '/user/user/profile',
        '/retryConfirmEmail' => '/user/user/retry-confirm-email',
        '/confirmEmail' => '/user/user/confirm-email',
        '/unbind/<id:[\w\-]+>' => '/user/auth/unbind',
        '/oauth/<authclient:[\w\-]+>' => '/user/auth/index'
    ],
],
'authManager' => [
    'class' => 'yii\rbac\DbManager',
],

'modules' => [
    'user' => [
        'class' => 'budyaga\users\Module',
        'userPhotoUrl' => 'http://example.com/uploads/user/photo',
        'userPhotoPath' => '@frontend/web/uploads/user/photo'
    ],
],

Instead of XXX, you have to use yours values. To receive them, you must create applications on the social networks.

If you are using advanced template and Yandex client, then you have to add authClientCollection in configurations for frontend and backend applications. However Yandex client should be added to only one of the applications. The reason for this is that Yandex one application can work with only one domain, you can not add two different Callback URL on different domains.

Not all services returns all user data. Some of the data get the default settings, if the service does not return them.

Database migrations

yii migrate/up --migrationPath=@vendor/budyaga/yii2-users/migrations

This migration create all necessary for the operation of the module tables and two users:

Usage

in main layout:

use budyaga\users\components\AuthorizationWidget;

<?= AuthorizationWidget::widget() ?>

Signup: http://example.com/signup

Profile: http://example.com/profile

Restore password: http://example.com/requestPasswordReset

Manage users: http://example.com/user/admin

Manage RBAC: http://example.com/user/rbac

Custom views and email templates

If you want use custom views and email templates you can override their in config. For example:

'modules' => [
    'user' => [
        'class' => 'budyaga\users\Module',
        'customViews' => [
            'login' => '@app/views/site/login'
        ],
        'customMailViews' => [
            'confirmChangeEmail' => '@app/mail/confirmChangeEmail' //in this case you have to create files confirmChangeEmail-html.php and confirmChangeEmail-text.php in mail folder
        ]
    ],
],

You can override all views from vendor\budyaga\yii2-users\views\user and vendor\budyaga\yii2-users\mail folders.