johnparra/yii2-auth

Yii 2 User Authentication & Role Based Access Control (RBAC) Module Fork of robregon

0.6.3 2016-07-23 18:59 UTC

Requires

• php: >=5.4.0
• yiisoft/yii2: *
• yiisoft/yii2-bootstrap: *
• yiisoft/yii2-composer: *
• yiisoft/yii2-swiftmailer: *

BSD-3-Clause

• robregonm

• Authentication
• user
• access
• auth
• yii
• rbac
• yii2

README

Auth Module is a flexible user registration, authentication & RBAC module for Yii2. It provides user authentication, registration and RBAC support to your Yii2 site.

Installation

The preferred way to install this extension is through composer.

Either run

$ php composer.phar require johnparra/yii2-auth "*"

or add

"johnparra/yii2-auth": "*"

to the require section of your composer.json file.

Usage

Once the extension is installed, modify your application configuration to include:

File config/web.php

return [
	'modules' => [
	    ...
	        'auth' => [
	            'class' => 'auth\Module',
	            'layout' => '//homepage', // Layout when not logged in yet
	            'layoutLogged' => '//main', // Layout for logged in users
	            'attemptsBeforeCaptcha' => 3, // Optional
	            'supportEmail' => '[e-mail]', // Email for notifications
	            'passwordResetTokenExpire' => 3600, // Seconds for token expiration
	            'superAdmins' => ['admin'], // SuperAdmin users
	            'signupWithEmailOnly' => false, // false = signup with username + email, true = only email signup
	            'tableMap' => [ // Optional, but if defined, all must be declared
	                'User' => 'user',
	                'UserStatus' => 'user_status',
	                'ProfileFieldValue' => 'profile_field_value',
	                'ProfileField' => 'profile_field',
	                'ProfileFieldType' => 'profile_field_type',
	            ],
	        ],
	    ...
	],
	...
	'components' => [
	    ...
		'authManager' => [
			'class' => '\yii\rbac\DbManager',
			'ruleTable' => 'AuthRule', // Optional
			'itemTable' => 'AuthItem',  // Optional
			'itemChildTable' => 'AuthItemChild',  // Optional
			'assignmentTable' => 'AuthAssignment',  // Optional
		],
		'user' => [
			'class' => 'auth\components\User',
			'identityClass' => 'auth\models\User', // or replace to your custom identityClass
			'enableAutoLogin' => true,
		],
	    ...
	]
];

File config/console.php

    'components' => [
        'authManager' => [
            'class' => 'yii\rbac\DbManager'
        ],
        'user' => [
            'class' => 'auth\components\User',
        ],
        'db' => $db,
    ],

    'modules' => [
        'auth' => [
                'class' => 'auth\Module',
                'superAdmins' => ['admin'], // SuperAdmin users
        ],
    ],

And run migrations:

$ php yii migrate/up --migrationPath=@auth/migrations

License

Auth module is released under the BSD-3 License. See the bundled LICENSE.md for details.

#INSTALLATION

./yii migrate/up --migrationPath=@auth/migrations

URLs

• Login: yourhost/auth/default/login
• Logout: yourhost/auth/default/logout
• Sign-up: yourhost/auth/default/signup
• Reset Password: yourhost/auth/default/reset-password
• User management: yourhost/auth/user/index
• User profile: yourhost/auth/profile/view