zakharov-andrew / yii2-user
Yii2 User
Installs: 356
Dependents: 1
Suggesters: 0
Security: 0
Stars: 3
Watchers: 2
Forks: 0
Open Issues: 0
Type:yii2-extension
Requires
- php: >=7.2
- dev-main
- v0.5.4
- v0.5.3
- v0.5.2
- v0.5.1
- v0.5.0
- v0.4.9
- v0.4.8
- v0.4.7
- v0.4.6
- v0.4.5
- v0.4.4
- v0.4.3
- v0.4.2
- v0.4.1
- v0.4.0
- v0.3.9
- v0.3.8
- v0.3.7
- v0.3.6
- v0.3.5
- v0.3.4
- v0.3.3
- v0.3.2
- v0.3.1
- v0.3.0
- v0.2.9
- v0.2.8
- v0.2.7
- v0.2.6
- v0.2.5
- v0.2.4
- v0.2.3
- v0.2.2
- v0.2.1
- v0.2.0
- v0.1.9
- v0.1.8
- v0.1.7
- v0.1.6
- v0.1.5
- v0.1.4
- v0.1.3
- v0.1.2
- v0.1.1
- v0.1.0
- 0.0.9
- 0.0.8
- 0.0.7
- 0.0.6
- 0.0.5
- 0.0.4
- v0.0.3
- v0.0.2
- v0.0.1
This package is auto-updated.
Last update: 2024-11-07 22:39:03 UTC
README
Yii2 user authentication module for management users and their rights.
- Registration, authorization, password recovery, change email and so on
- User administration interface
- Supports role creation
- Multiple user roles are supported
- Happy Birthday widgets
- Supports languages: English, Russian
Installation
The preferred way to install this extension is through composer.
Either run
$ composer require zakharov-andrew/yii2-user
or add
"zakharov-andrew/yii2-user": "*"
to the require
section of your composer.json
file.
Subsequently, run
./yii migrate/up --migrationPath=@vendor/zakharov-andrew/yii2-user/migrations
in order to create the settings table in your database.
Or add to console config
return [ // ... 'controllerMap' => [ // ... 'migrate' => [ 'class' => 'yii\console\controllers\MigrateController', 'migrationPath' => [ '@console/migrations', // Default migration folder '@vendor/zakharov-andrew/yii2-user/src/migrations' ] ] // ... ] // ... ];
Usage
Add this to your main configuration's modules array
'modules' => [ 'user' => [ 'class' => 'ZakharovAndrew\user\Module', 'bootstrapVersion' => 5, // if use bootstrap 5 'showTitle' => true, // display H1 headings (default - true) 'telegramToken' => '', // necessary for the bot to work 'telegramBotLink' => 'https://t.me/YOUR_BOT_NAME_FOR_USER_LINK', //change! // use for menu and access 'controllersAccessList' => [ 1001 => [ 'Users' => [ '/user/user/index' => 'users', '/user/user/create' => 'create user', ], ], 1002 => ['/user/roles/index' => 'Roles'] ] ], // ... ],
Add this to your config\params.php
return [ // ... 'supportEmail' => 'change-this-email@test.com', // lifetime of the password reset token 'userResetPasswordTokenExpire' => 3600 // ... ];
If a pretty URL is enabled:
Add this to your main configuration's urlManager array
'urlManager' => [ //... 'rules' => [ 'login' => 'user/user/login', 'logout' => 'user/user/logout', 'profile' => 'user/user/profile', //... ], //... ],
Happy Birthday widget
You can use the birthday greeting widget by customizing both the header and the message indicating that there are no birthdays today:
<?= \ZakharovAndrew\user\components\BirthdayWidget::widget([ 'headerMessage' => 'Today’s birthdays:', 'noBirthdaysMessage' => 'Today, no one is celebrating a birthday.', // or empty 'useAvatars' => true ]); ?>
Widget for congratulating the user on his birthday:
<?= \ZakharovAndrew\user\components\BirthdayGreetingWidget::widget([ 'message' => '<h1>Happy Birthday, {username}!</h1>' ]) ?>
License
yii2-user it is available under a MIT License. Detailed information can be found in the LICENSE.md
.