Class dektrium\user\Module
| Inheritance | dektrium\user\Module » yii\base\Module |
|---|
This is the main module class for the Yii2-user.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $adminPermission | string | The Administrator permission name. | dektrium\user\Module |
| $admins | array | An array of administrator's usernames. | dektrium\user\Module |
| $confirmWithin | integer | The time before a confirmation token becomes invalid. | dektrium\user\Module |
| $cost | integer | Cost parameter used by the Blowfish hash algorithm. | dektrium\user\Module |
| $debug | boolean | Is the user module in DEBUG mode? Will be set to false automatically if the application leaves DEBUG mode. | dektrium\user\Module |
| $emailChangeStrategy | integer | Email changing strategy. | dektrium\user\Module |
| $enableAccountDelete | boolean | Whether user can remove his account | dektrium\user\Module |
| $enableConfirmation | boolean | Whether user has to confirm his account. | dektrium\user\Module |
| $enableFlashMessages | boolean | Whether to show flash messages. | dektrium\user\Module |
| $enableGeneratingPassword | boolean | Whether to remove password field from registration form. | dektrium\user\Module |
| $enableImpersonateUser | boolean | Enable the 'impersonate as another user' function | dektrium\user\Module |
| $enablePasswordRecovery | boolean | Whether to enable password recovery. | dektrium\user\Module |
| $enableRegistration | boolean | Whether to enable registration. | dektrium\user\Module |
| $enableUnconfirmedLogin | boolean | Whether to allow logging in without confirmation. | dektrium\user\Module |
| $mailer | array | Mailer configuration | dektrium\user\Module |
| $modelMap | array | Model map | dektrium\user\Module |
| $recoverWithin | integer | The time before a recovery token becomes invalid. | dektrium\user\Module |
| $rememberFor | integer | The time you want the user will be remembered without asking for credentials. | dektrium\user\Module |
| $urlPrefix | string | The prefix for user module URL. | dektrium\user\Module |
| $urlRules | array | The rules to be used in URL management. | dektrium\user\Module |
Constants
| Constant | Value | Description | Defined By |
|---|---|---|---|
| STRATEGY_DEFAULT | 1 | Email is changed after user clicks confirmation link sent to his new email address. | dektrium\user\Module |
| STRATEGY_INSECURE | 0 | Email is changed right after user enter's new email address. | dektrium\user\Module |
| STRATEGY_SECURE | 2 | Email is changed after user clicks both confirmation links sent to his old and new email addresses. | dektrium\user\Module |
| VERSION | '0.9.12' | dektrium\user\Module |
Property Details
The Administrator permission name.
An array of administrator's usernames.
The time before a confirmation token becomes invalid.
Cost parameter used by the Blowfish hash algorithm.
Is the user module in DEBUG mode? Will be set to false automatically if the application leaves DEBUG mode.
Email changing strategy.
Whether user can remove his account
Whether user has to confirm his account.
Whether to show flash messages.
Whether to remove password field from registration form.
Enable the 'impersonate as another user' function
Whether to enable password recovery.
Whether to enable registration.
Whether to allow logging in without confirmation.
Mailer configuration
Model map
The time before a recovery token becomes invalid.
The time you want the user will be remembered without asking for credentials.
The prefix for user module URL.
The rules to be used in URL management.