Download the PHP package yii2mod/yii2-user without Composer
On this page you can find all versions of the php package yii2mod/yii2-user. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download yii2mod/yii2-user
More information about yii2mod/yii2-user
Files in yii2mod/yii2-user
Informations about the package yii2-user
Yii2 User Extension
Flexible user registration and authentication module for Yii2
Installation
The preferred way to install this extension is through composer.
Either run
or add
to the require section of your composer.json
file.
Actions
This extension provides several independent action classes, which provides particular operation support:
- [[yii2mod\user\actions\LoginAction]] - Logs in a user. The following additional parameters are available:
view
- name of the view, which should be rendered.modelClass
- login model class name.layout
- the name of the layout to be applied to this view.returnUrl
- url which user should be redirected to on success.
- [[yii2mod\user\actions\LogoutAction]] - Logs out the current user. The following additional parameters are available:
returnUrl
- url which user should be redirected to on success.
- [[yii2mod\user\actions\SignupAction]] - Signup a user. The following additional parameters are available:
view
- name of the view, which should be rendered.modelClass
- signup model class name.returnUrl
- url which user should be redirected to on success.
- [[yii2mod\user\actions\RequestPasswordResetAction]] - Request password reset for a user. The following additional parameters are available:
view
- name of the view, which should be rendered.modelClass
- request password model class.successMessage
- message to the user when the mail is sent successfully.errorMessage
- error message for the user when the email was not sent.returnUrl
- url which user should be redirected to on success.
- [[yii2mod\user\actions\PasswordResetAction]] - Reset password for a user. The following additional parameters are available:
view
- name of the view, which should be rendered.modelClass
- reset password model class.successMessage
- message to be set on success.returnUrl
- url which user should be redirected to on success.
Configuration
1) If you use this extension without base template, then you need execute migration by the following command:
2) You need to configure the params
section in your project configuration:
3) Your need to create the UserModel class that be extends of UserModel and configure the property identityClass
for user
component in your project configuration, for example:
4) For sending emails you need to configure the mailer
component in the configuration of your project.
5) If you don't have the passwordResetToken.php
template file in the mail folder of your project, then you need to create it, for example:
This template used for password reset email.
6) Add to SiteController (or configure via $route
param in urlManager):
You can then access to this actions through the following URL:
- http://localhost/site/login
- http://localhost/site/logout
- http://localhost/site/signup
- http://localhost/site/request-password-reset
- http://localhost/site/password-reset
7) Also some actions send flash messages, so you should use an AlertWidget to render flash messages on your site.
Using action events
You may use the following events:
Console commands
Setup
To enable console commands, you need to add module into console config of you app.
/config/console.php
in yii2-app-basic template, or /console/config/main.php
in yii2-app-advanced.
Available console actions
-
user/create - Creates a new user.
-
user/role/assign - Assign role to the user.
-
user/role/revoke - Revoke role from the user.
-
user/delete - Deletes a user.
- user/update-password - Updates user's password to given.
Internationalization
All text and messages introduced in this extension are translatable under category 'yii2mod.user'. You may use translations provided within this extension, using following application configuration:
Support us
Does your business depend on our contributions? Reach out and support us on Patreon. All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.
All versions of yii2-user with dependencies
yiisoft/yii2 Version >=2.0.8
yiisoft/yii2-swiftmailer Version *
yii2mod/yii2-enum Version *