README

1 简介

用户模块 -- 为Yii2框架提供的模块，提供用户管理功能，可以修改默认的用户资料数据

名称
登录名
电子邮件
密码
状态
角色（如果应用程序中存在authManager并且rbacManage为true）

2 依赖

php >= 7.1
composer
MySql >= 5.5

3 安装

通过composer

composer require "itstructure/yii2-users-module": "^1.6.0"

或在composer.json文件的require部分设置以下内容

"require": {
    "itstructure/yii2-users-module": "^1.6.0"
}

并执行命令composer install，如果先安装yii2项目的扩展包，

或执行命令composer update，如果已安装所有yii2项目的扩展包。

4 使用方法

4.1 主要属性

模块的名称：users
用于类的命名空间：Itstructure\UsersModule。
访问模块根目录的别名：@users。
没有布局！ 默认从应用程序布局 main 中获取，或者按照配置的方式。您可以通过自定义在模块中设置layout属性。
视图组件默认从框架中获取，如 yii\web\View。您可以通过自定义在模块中设置视图组件。

4.2 应用程序配置

基本应用程序配置必须如下所示

use Itstructure\UsersModule\Module;
use Itstructure\UsersModule\controllers\ProfileController;

'modules' => [
    'users' => [
        'class' => Module::class,
        'controllerMap' => [
            'profile' => ProfileController::class,
        ],
    ],
],

4.3 有用的模块属性

loginUrl - 设置未授权时重定向的URL。
rbacManage - 如果为 true，则将涉及以下功能
- roles 字段在 ProfileValidate 模型中用于验证角色。
- roles 字段在 create、update 和 _form 模板中。
将通过 authManager 从应用程序自动加载存在的角色。
accessRoles - 允许访问的用户角色。
customRewrite - 如果为 true，则完全覆盖以下 profile 属性，而不是与自定义值合并
- rules、attributes、attributeLabels 在 ProfileValidate 模型中由自定义值覆盖，这些值可以在 ProfileValidateComponent 中设置。
- _form 模板中的表单字段由自定义的 formFields 值覆盖，这些值可以在 ProfileValidateComponent 中设置。
- index 模板中的GridView列由自定义的 indexViewColumns 值覆盖，这些值可以在 ProfileValidateComponent 中设置。
- view 模板中的DetailView属性由自定义的 detailViewAttributes 值覆盖，这些值可以在 ProfileValidateComponent 中设置。
如果 customRewrite 为 false，则上述列出的参数将与自定义值合并。

示例

use Itstructure\UsersModule\Module;
use Itstructure\UsersModule\components\ProfileValidateComponent;

'modules' => [
    'users' => [
        'class' => Module::class,
        'controllerMap' => [
            'profile' => ProfileController::class,
        ],
        'accessRoles' => ['admin', 'manager'],
        'components' => [
            'profile-validate-component' => [
                'class' => ProfileValidateComponent::class,
                'rules' => [...],
                'attributes' => [...],
                'attributeLabels' => [...],
                'formFields' => [...],
                'indexViewColumns' => [...],
                'detailViewAttributes' => [...],
            ],
        ]
    ],
],

警告！要正确设置 ProfileValidateComponent 的参数，请参考视图配置模板和默认的 ProfileValidate 模型中的设置作为示例。

许可证

遵循 MIT 许可证。详细信息请参阅 LICENSE.txt。

itstructure / yii2-users-module

维护者

详细信息