yii-extension / user
Flexible user registration and authentication module for Yii3
This package's canonical repository appears to be gone and the package has been frozen as a result.
dev-main / 1.0.x-dev
2023-07-17 19:16 UTC
Requires
- php: >=8.1
- ext-fileinfo: *
- ext-filter: *
- php-forge/awesome-component: ^1.0@dev
- php-forge/filepond-widget: ^1.0@dev
- php-forge/form-awesome: ^1.0@dev
- php-forge/form-model: ^1.0@dev
- php-forge/helpers: ^1.0@dev
- php-forge/html: ^1.0@dev
- php-forge/table-builder: ^1.0@dev
- psr/http-message: ^1.0
- psr/http-server-handler: ^1.0
- psr/http-server-middleware: ^1.0
- psr/log: ^3.0
- psr/simple-cache: ^2.0
- yii-tools/data-provider: ^1.0@dev
- yii-tools/filepond-asset: ^1.0@dev
- yii-tools/flowbite-asset: ^1.0@dev
- yii-tools/fontawesome-asset: ^2.0
- yii-tools/service: ^1.0@dev
- yii-tools/sweetalert2-asset: dev-main
- yii-tools/yii-validator: ^1.0@dev
- yiisoft/active-record: ^3.0@dev
- yiisoft/aliases: ^3.0
- yiisoft/arrays: ^3.0
- yiisoft/assets: ^4.0
- yiisoft/auth: ^3.0
- yiisoft/csrf: ^2.0
- yiisoft/data-response: ^2.0
- yiisoft/db: ^1.0
- yiisoft/files: ^2.0
- yiisoft/http: ^1.2
- yiisoft/mailer: ^5.0
- yiisoft/middleware-dispatcher: ^5.0
- yiisoft/router: ^3.0
- yiisoft/router-fastroute: ^3.0
- yiisoft/security: ^1.0
- yiisoft/session: ^2.0
- yiisoft/strings: ^2.1
- yiisoft/translator: ^3.0
- yiisoft/translator-message-php: ^1.1
- yiisoft/user: ^2.0
- yiisoft/validator: ^1.0
- yiisoft/yii-db-migration: ^1.0@dev
Requires (Dev)
- codeception/c3: ^2.8
- codeception/codeception: ^5.0
- codeception/module-asserts: ^3.0
- codeception/module-db: ^3.0
- codeception/module-phpbrowser: ^3.0
- codeception/stub: ^4.1
- httpsoft/http-message: ^1.0.5
- maglnet/composer-require-checker: ^4.2
- php-forge/support: ^1.0@dev
- symfony/process: ^6.2
- vimeo/psalm: ^5.6
- yii-tools/app: ^1.0@dev
- yii-tools/codeception-module-yii3: ^1.0@dev
- yii-tools/skeleton-app: ^1.0@dev
- yiisoft/config: ^1.3
- yiisoft/db-sqlite: ^1.0
- yiisoft/definitions: ^3.2
- yiisoft/di: ^1.2
- yiisoft/files: ^2.0
- yiisoft/translator-extractor: ^2.0
- yiisoft/yii-event: ^2.0
- yiisoft/yii-view: ^6.0
This package is auto-updated.
Last update: 2024-01-17 20:21:26 UTC
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).
Note: check the directory /runtime/mail
, the emails are stored in it.
Testing
Check the documentation testing to learn about testing.
CI status
License
The MIT License (MIT). Please see License File for more information.