README

Flexible user registration and authentication module for Yii3.

Project

In this link you will find the lists of tasks to implement: task-list

Installation

Yiisoft application template yiisoft/app.

composer create-project --prefer-dist --stability=dev yiisoft/app <your project>

cd <your project>
composer require yii-tools/user:@dev yii-tools/flowbite-asset:^1.0

Install your driver for the database, for example sqlite.

cd <your project>
composer require yiisoft/db-sqlite:^1.0

Configuration

If you want to customize yii-tools/user, read the docs.

Directory structure

root
├── config                              Configuration files.
│   └── common                          Common configuration files.
|       └── param                       Common parameters configuration file.
│       └── yii-tools-user.php          User module configuration file.
│       └── yiisoft-translator.php      Translator configuration file.
│   └── console                         Console configuration files.
│       └── param                       Console parameters configuration file.
│   └── web                             Web configuration files.
│       └── param                       Web parameters configuration file.
│       └── yiisoft-auth.php            Authentication configuration file.
│       └── yiisoft-cookies.php         Cookies configuration file.
├── src                                 Application source code.
│   └── UserModule.php                  User module class.
│   └── UserModuleInterface.php         User module interface class.
│   └── Framework                       Framework classes.
│       └── Asset                       Asset classes.
|       └── Definition                  Definition classes.
│       └── Migration                   Migration classes.
│       └── Repository                  Repository classes.
│       └── Service                     Service classes.
│           └── resource                Resource files.
│               └── asset               Custom asset files.
│               └── mailer              Mailer files.
│               └── message             Message files translation.
│   └── Helper                          Helper classes.
│   └── Model                           Model classes.
│   └── Repository                      Repository interface classes.
│   └── Service                         Service classes.
│   └── UseCase                         Use case classes with vertical slices.
│       └── AdminManagement             Classes for function admin management.
│       └── BlockByAdmin                Classes for function block by admin.
│       └── Confirmation                Classes for function confirmation.
│       └── ConfirmationByAdmin         Classes for function confirmation by admin.
│       └── DeleteByAdmin               Classes for function delete by admin.
│       └── EmailChange                 Classes for function email change.
│       └── EmailStrategy               Classes for function email strategy.
│       └── Login                       Classes for function login.
│       └── Logout                      Classes for function logout.
│       └── PasswordRequest             Classes for function password request.
│       └── PasswordReset               Classes for function password reset.
│       └── ProfileUpdate               Classes for function profile update.
│       └── Registration                Classes for function registration.
│       └── ResendConfirmation          Classes for function resend confirmation.
│       └── UnblockByAdmin              Classes for function unblock by admin.
│       └── UpdateByAdmin               Classes for function update by admin.
├── codeception.yml                 Codeception configuration.
├── composer.json                   Composer configuration.
├── tailwind.config.js              Tailwind CSS configuration.

Run command console

./yii

Run migration

Application template:

./yii m:u

Using PHP built-in server

php -S 127.0.0.1:8080 -t public

Wait till it is up, then open the following URL in your browser

http://localhost:8080

Includes the following features:

User module:
- [/user/login] - Display login form.
- [/user/logout] - Log the user out.
- [/user/confirm[/{id}/{token}]] - Confirms a user (requires id and token query params).
- [/user/profile] - Displays profile form.
- [/user/register] - Displays registration form.
- [/user/request] - Displays recovery request form.
- [/user/resend] - Displays resend form.
- [/user/reset[/{id}/{token}]] - Displays password reset form (requires id and token query params).
- [/user/email/change] - Displays email change form.
- [/user/email/attempt[/{id}/{token}]] - Confirm email change (requires id and token query params).