Yii 2 User - User authentication module
2014/6/14 - Yii 2 has recently implemented a breaking change which may affect the logout
functionality. If you are getting a "Method Not Allowed - #405", you will need to add
<?= Html::csrfMetaTags() ?> to the <head> section in your main layout file. See
here and
here.
2014/4/28 - I have just released 2.0.0-alpha. This release is basically a code overhaul and does not contain any functionality changes.
IF THIS BROKE YOUR APP, the quick fix is to limit your version via composer:
"amnah/yii2-user": "1.0.0@beta". Otherwise, please see the Upgrade Notes
to sync your app with this latest version.
- Quick setup - works out of the box so you can see what it does
- Easily extendable
- Registration using email and/or username
- Login using email and/or username
- Email confirmation (+ resend functionality)
- Social authentication (facebook, twitter, google, linkedin, reddit)
- Account page
- Updates email, username, and password
- Requires current password
- Profile page
- Lists custom fields for users, e.g., full_name
- Password recovery
- Admin crud via GridView
- Install Yii 2 using your preferred method
- Install package via composer
"amnah/yii2-user": "~2.0" - Update config file config/web.php and config/db.php
// app/config/web.php
return [
'components' => [
// NOTE: in the yii2-advanced-app, the user component should be updated in
// 'frontend/config/main.php' and/or 'backend/config/main.php' (OR you can add it
// to 'common/config' if you remove it from frontend/backend)
'user' => [
'class' => 'amnah\yii2\user\components\User',
],
'mail' => [
'class' => 'yii\swiftmailer\Mailer',
'useFileTransport' => true,
'messageConfig' => [
'from' => ['[email protected]' => 'Admin'], // this is needed for sending emails
'charset' => 'UTF-8',
]
]
],
'modules' => [
'user' => [
'class' => 'amnah\yii2\user\Module',
// set custom module properties here ...
],
],
];
// app/config/db.php
return [
'class' => 'yii\db\Connection',
// set up db info
];- Run migration file
php yii migrate --migrationPath=@vendor/amnah/yii2-user/migrations
- Go to your application in your browser
http://localhost/pathtoapp/web/user
- Log in as admin using
neo/neo(change it!) - Set up module properties as desired
- Optional - Update the nav links in your main layout app/views/layouts/main.php
// app/views/layouts/main.php
<?php
'items' => [
['label' => 'Home', 'url' => ['/site/index']],
['label' => 'About', 'url' => ['/site/about']],
['label' => 'Contact', 'url' => ['/site/contact']],
['label' => 'User', 'url' => ['/user']],
Yii::$app->user->isGuest ?
['label' => 'Login', 'url' => ['/user/login']] :
['label' => 'Logout (' . Yii::$app->user->displayName . ')',
'url' => ['/user/logout'],
'linkOptions' => ['data-method' => 'post']],
],Release Notes (Upgrade Notes)
- 2014/6/12 - Release 2.1.0-alpha2
- 2014/5/19 - Release 2.1.0-alpha
- 2014/4/28 - Release 2.0.0-alpha
- 2014/4/17 - Release 1.0.0-beta
This package contains a custom permissions system. Every user has a role, and that role has permissions
in the form of database columns. It should follow the format: can_{permission name}.
For example, the role table has a column named can_admin by default. To check if the user can
perform admin actions:
if (!Yii::$app->user->can("admin")) {
throw new HttpException(403, 'You are not allowed to perform this action.');
}
// --- or ----
$user = User::findOne(1);
if ($user->can("admin")) {
// do something
};Add more database columns for permissions as needed. If you need something more powerful, look into setting up [RBAC] (https://github.com/yiisoft/yii2/blob/master/docs/guide/authorization.md).
Note: If you set up an authManager component for RBAC, then Yii::$app->user->can() will use
that instead of this module's custom role table.
Check out this great 3-step guide by dektrium. (Please note that the scenarios for the validation rules will depend on your project requirements.)
You can extend the classes directly. Depending on which ones you need, set the proper config property:
// app/config/web.php
'components' => [
'user' => [
'class' => 'app\components\MyUser',
],
],
'modules' => [
'user' => [
'class' => 'app\modules\MyModule',
'controllerMap' => [
'default' => 'app\controllers\MyDefaultController',
],
'modelClasses' => [
'Profile' => 'app\models\MyProfile',
],
'emailViewPath' => '@app/mail/user', // example: @app/mail/user/confirmEmail.php
],
],For view files, you can use the theme component.
// app/config/web.php
'components' => [
'view' => [
'theme' => [
'pathMap' => [
'@vendor/amnah/yii2-user/views' => '@app/views/user', // example: @app/views/user/default/login.php
],
],
],
],You can always fork the package and modify it as needed.
Or, if you want, you can integrate the package directly into your app by copying the files. This would
make it more difficult to get updates, but it also guarantees that your app won't break after running
composer update.
To do so, you can use the helper command CopyController.
- Add the module to your config/console.php to gain access to the command (Note: this is CONSOLE config)
// app/config/console.php
'modules' => [
'user' => [
'class' => 'amnah\yii2\user\Module',
],
],- Use the
php yii user/copycommand. For a [basic app] (https://github.com/yiisoft/yii2-app-basic), you can call the default command without any options
php yii user/copy --from=@vendor/amnah/yii2-user --to=@app/modules/user --namespace=app\\modules\\user
- Update config to point to your new package
// app/config/web.php + app/config/console.php
'modules' => [
'user' => [
'class' => 'app\modules\user\Module',
],
],Alternatively, you can do this manually. Just copy/paste the files wherever you'd like and
change the namespaces in the files. Replace amnah\yii2\user with app\modules\user.
- il8n
- Tests
- Issues/requests? Submit a github issue
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent