<commit_before>yii2-user
=========

A configurable user management module for Yii framework 2.0 with inbuilt social authentication and various user management controls. The module has been intentionally kept simple - yet enable yii developers to achieve user management & control for various use cases and scenarios. The module does not have RBAC (Role Based Access Control) inbuilt as an intention to keep it simple. There are few access control methods that help achieve various use cases. However, for building advanced / comple specific use cases, almost every feature has been enabled to be configurable and extensible by the developer. Be it the module rules & settings, the model classes, the controller actions, the layouts, or the views - each of these can be customized. In addition few reusable components and widgets have been provided for expanding and building further use cases.

#### _This extension is under development and not completely ready for use._

## Features and Concepts

### Primary User Statuses

#### Superuser

_INTERNAL STATUS_

There is typically one superuser for each application and is created by default on install. Superusers cannot be modified by other users except the superuser himself / herself.

#### Admin

_EDITABLE STATUS_

Administrators behave like superusers - but can be inactivated or manipulated by superusers or administrators based on module level settings.

#### Pending

_INTERNAL STATUS_

By default users are placed in pending status when registered. This will not be applicable if you have `autoActivate` setting to `false` in your `registrationSettings`

#### Active

_EDITABLE STATUS_

Whether the user is active and allowed access to the application. Admin and Superuser have accesses to application by default.

#### Inactive

_EDITABLE STATUS_

Whether the user is inactive (banned / deleted). No access will be allowed for inactive users to the application. Admin and Superuser can view / manage inactive users.

### Secondary Statuses

#### Expired

_INTERNAL STATUS_

Whenever a password for an user account expires, the user is placed into this additional status, and guided to changing his / her password. This feature can be controlled by configuring `passwordExpiry` in `passwordSettings`. This status is additionally applicable in addition to the primary statuses above (other than `Inactive`).

#### Locked

_INTERNAL STATUS_

Whenever an user types a wrong password for a specified number of times consecutively - his / her account is locked. This is controlled by configuring `wrongAttempts` in  `passwordSettings`. This status is additionally applicable in addition to the primary statuses above (other than `Inactive`).

#### _More concepts and usage information to be added later in detailed documentation_
<commit_msg>Initial release<commit_after>yii2-user
=========

A configurable user management module for Yii framework 2.0 with inbuilt social authentication and various user management controls. The module has been intentionally kept simple - yet enable yii developers to achieve user management & control for various use cases and scenarios. The module does not have RBAC (Role Based Access Control) inbuilt as an intention to keep it simple. There are few access control methods that help achieve various use cases. However, for building advanced / comple specific use cases, almost every feature has been enabled to be configurable and extensible by the developer. Be it the module rules & settings, the model classes, the controller actions, the layouts, or the views - each of these can be customized. In addition few reusable components and widgets have been provided for expanding and building further use cases.

#### _This extension is under development and not completely ready for use._

## Features and Concepts

### Primary User Statuses

#### Superuser

_INTERNAL STATUS_

There is typically one superuser for each application and is created by default on install. Superusers cannot be modified by other users except the superuser himself / herself.

#### Admin

_EDITABLE STATUS_

Administrators behave like superusers - but can be inactivated or manipulated by superusers or administrators based on module level settings.

#### Pending

_INTERNAL STATUS_

By default users are placed in pending status when registered. This will not be applicable if you have `autoActivate` setting to `true` in your `registrationSettings`

#### Active

_EDITABLE STATUS_

Whether the user is active and allowed access to the application. Admin and Superuser have accesses to application by default.

#### Inactive

_EDITABLE STATUS_

Whether the user is inactive (banned / deleted). No access will be allowed for inactive users to the application. Admin and Superuser can view / manage inactive users.

### Secondary Statuses

#### Expired

_INTERNAL STATUS_

Whenever a password for an user account expires, the user is placed into this additional status, and guided to changing his / her password. This feature can be controlled by configuring `passwordExpiry` in `passwordSettings`. This status is additionally applicable in addition to the primary statuses above (other than `Inactive`).

#### Locked

_INTERNAL STATUS_

Whenever an user types a wrong password for a specified number of times consecutively - his / her account is locked. This is controlled by configuring `wrongAttempts` in  `passwordSettings`. This status is additionally applicable in addition to the primary statuses above (other than `Inactive`).

#### _More concepts and usage information to be added later in detailed documentation_

{'fraction_non_alphanumeric': 0.04539767649687221, 'fraction_numerical': 0.0010723860589812334, 'mean_word_length': 4.8170478170478175, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4751036', 'n_tokens_mistral': 1286, 'n_tokens_neox': 1235, 'n_words': 787}