humanized/yii2-user

This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.

User Administration Module for Yii2. This module wraps and extends the default user management interface provided by the framework. Several parts of this module however, are designed to be fully compatible with the factory-provided implementations related to user management. For this, several config

Installs: 123

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 3

Forks: 1

Open Issues: 0

Type:yii2-extension

dev-master 2016-04-18 01:24 UTC

This package is not auto-updated.

Last update: 2021-09-28 06:35:32 UTC


README

Yii2

Provides various interfaces to deal with routine user management tasks.

This extension is under heavy development and requires the use of Yii framework version 2.0.7 This version of the framework is currently in active development

This module should be considered highly unstable and it's use is discouraged until further notice (really)

Version 0.1 Release notes:

Features

This module aims to be a clean, modular and simple user-administration module which can be used for Yii 2 projects version 2.0.7 and up.

A first goal is to wrap the user management functionalities provided by the yii2-advanced template to allow easy porting to other templates, such as the yii2-basic-template. Essentially, this module can functionally achieve the same as provided by the advanced template, with little to no changes made to the interface provided and minor changes to made layout.

Other than providing the stock functionality, a lot has been made configurable:

  • Email-based login by default, over storage of a username/email combination;
  • Enable/Disable guest signup;
  • Graceful handling of (optional) account status codes;

A next goal deals with the implementation of some missing core user account functionality:

  • Account Confirmation
  • Token Based Authentication
  • RBAC Integration

Functionality will be added to this module, as it becomes required for incorporation in further projects. We accept pull-requests!

The following functionality is due expected due in further versions:

  • PhpCAS Integration (due version 0.2)
  • OAuth Integration (due version 0.3)
  • REST API (due version 0.4)

Installation

Install Using Composer

The preferred way to install this extension is through composer.

Either run

$ php composer.phar require humanized/yii2-user "dev-master"

or add

"humanized/yii2-user": "dev-master"

to the require section of your composer.json file.

Add Module to Configuration

Add following lines to the configuration file:

'modules' => [
    'user' => [
        'class' => 'humanized\user\Module',
    ],
],

For full instructions how to configure this module, check the CONFIG-file.

Run Migrations

$ php yii migrate/up --migrationPath=@vendor/humanized/yii2-user/migrations

For full instructions on how to use this module, once configured, check the USAGE-file.