filsh / yii2-user
Yii 2 user authentication module
Installs: 88
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 104
Type:yii2-extension
Requires
- yiisoft/yii2: *
This package is auto-updated.
Last update: 2024-10-29 04:14:37 UTC
README
Yii 2 User - User authentication module
Demo
Features
- Quick setup - works out of the box so you can see what it does
- Easily extendable (instructions below)
- Registration using email and/or username
- Login using email and/or username
- Email confirmation (+resend functionality)
- 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
Installation
- Install Yii 2 using your preferred method
- Install package via composer
"filsh/yii2-user": "dev-master"
- Update config file config/web.php and config/db.php
// app/config/web.php return [ 'components' => [ 'user' => [ 'class' => 'filsh\yii2\user\components\User', ], 'mail' => [ // set up mail for emails ] ], 'modules' => [ 'user' => [ 'class' => 'filsh\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/filsh/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']], ],
Development
How do I check user permissions?
This package contains a very simple 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); $user->can("admin");
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.
How do I extend this package?
You can extend the classes directly. Depending on which ones you need to extend, 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', ], 'viewPath' => '@app/views/user', // file example: @app/views/user/default/profile.php 'emailViewPath' => '@app/mails', // file example: @app/mails/confirmEmail.php ], ],
I need more control. Can I just extend the whole thing?
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
.
I've created a helper command to copy the files for you.
- 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' => 'filsh\yii2\user\Module', ], ],
- Use the
php yii user/copy
command. For a [basic] (https://github.com/yiisoft/yii2-app-basic) app, you can call the default command without any options
php yii user/copy --from=@vendor/filsh/yii2-user/filsh/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 filsh\yii2\user
with app\modules\user
.
Changelog
- 2014/4/17 - Release 1.0.0-beta
Todo
- Tests
- Add functionality for user groups (possibly as another package)
- Issues/requests? Submit a github issue