| Server IP : 49.231.201.246 / Your IP : 216.73.216.149 Web Server : Apache/2.4.18 (Ubuntu) System : Linux 246 4.4.0-210-generic #242-Ubuntu SMP Fri Apr 16 09:57:56 UTC 2021 x86_64 User : root ( 0) PHP Version : 7.0.33-0ubuntu0.16.04.16 Disable Function : exec,passthru,shell_exec,system,proc_open,popen,pcntl_exec MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /proc/11585/cwd/html/water/vendor/dektrium/yii2-user/docs/ |
Upload File : |
# 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.
```php
return [
'id' => 'app-console',
'modules' => [
'user' => [
'class' => 'dektrium\user\Module',
],
],
...
```
## Available console actions
- **user/confirm** Confirms a user.
- **user/create** Creates new user account.
- **user/delete** Deletes a user.
- **user/password** Updates user's password.
### user/confirm
Confirms a user by setting confirmed_at field to current time.
```sh
./yii user/confirm <search> [...options...]
- search (required): string
Email or username
```
### user/create
This command creates new user account. If password is not set, this command will generate new 8-char password.
After saving user to database, this command uses mailer component to send credentials (username and password) to
user via email.
```sh
./yii user/create <email> <username> [password] [...options...]
- email (required): string
Email address
- username (required): string
Username
- password: null|string
Password (if null it will be generated automatically)
```
### user/delete
Deletes a user.
```sh
./yii user/delete <search> [...options...]
- search (required): string
Email or username
```
### user/password
Updates user's password to given.
```sh
./yii user/password <search> <password> [...options...]
- search (required): string
Email or username
- password (required): string
New password
```