README

此仓库未积极维护。如果您想添加一些更改，只需将其分支并安全地使用您的分支。

优点

• 用户管理
• 具有Web界面的RBAC（角色、权限等）
• 注册、授权、密码恢复等
• 访问日志
• 优化（常规用户工作流程中不进行数据库查询）
• 如GhostMenu或GhostHtml::a之类的精美小部件，其中元素仅在用户有权访问它们所指向的路由时才可见

安装

安装此扩展的首选方式是通过composer。

运行

composer require vanterbit/module-user-management

或将

"vanterbit/module-user-management": "^1"

添加到您的composer.json文件的require部分。

配置

1. 在您的config/web.php中

'components'=>[
	'user' => [
		'class' => 'vanterbit\modules\UserManagement\components\UserConfig',

		// Comment this if you don't want to record user logins
		'on afterLogin' => function($event) {
				\vanterbit\modules\UserManagement\models\UserVisitLog::newVisitor($event->identity->id);
			}
	],
],

'modules'=>[
	'user-management' => [
		'class' => 'vanterbit\modules\UserManagement\UserManagementModule',

		// 'enableRegistration' => true,

		// Add regexp validation to passwords. Default pattern does not restrict user and can enter any set of characters.
		// The example below allows user to enter :
		// any set of characters
		// (?=\S{8,}): of at least length 8
		// (?=\S*[a-z]): containing at least one lowercase letter
		// (?=\S*[A-Z]): and at least one uppercase letter
		// (?=\S*[\d]): and at least one number
		// $: anchored to the end of the string

		//'passwordRegexp' => '^\S*(?=\S{8,})(?=\S*[a-z])(?=\S*[A-Z])(?=\S*[\d])\S*$',
		

		// Here you can set your handler to change layout for any controller or action
		// Tip: you can use this event in any module
		'on beforeAction'=>function(yii\base\ActionEvent $event) {
				if ( $event->action->uniqueId == 'user-management/auth/login' )
				{
					$event->action->controller->layout = 'loginLayout.php';
				};
			},
	],
],

有关事件的更多信息，请参阅

• https://yiiframework.cn/doc-2.0/guide-concept-events.html
• https://yiiframework.cn/doc-2.0/guide-concept-configurations.html#configuration-format

在AuthHelper::layoutHandler()中的布局处理器示例

要查看完整选项列表，请检查UserManagementModule文件

1. 在您的config/console.php中（这是迁移和与控制台一起工作所需的）

'modules'=>[
	'user-management' => [
		'class' => 'vanterbit\modules\UserManagement\UserManagementModule',
	        'controllerNamespace'=>'vendor\vanterbit\modules\UserManagement\controllers', // To prevent yii help from crashing
	],
],

1. 运行迁移

./yii migrate --migrationPath=vendor/vanterbit/module-user-management/migrations/

1. 在您的基控制器中

public function behaviors()
{
	return [
		'ghost-access'=> [
			'class' => 'vanterbit\modules\UserManagement\components\GhostAccessControl',
		],
	];
}

您可以访问的地方

<?php
use vanterbit\modules\UserManagement\components\GhostMenu;
use vanterbit\modules\UserManagement\UserManagementModule;

echo GhostMenu::widget([
	'encodeLabels'=>false,
	'activateParents'=>true,
	'items' => [
		[
			'label' => 'Backend routes',
			'items'=>UserManagementModule::menuItems()
		],
		[
			'label' => 'Frontend routes',
			'items'=>[
				['label'=>'Login', 'url'=>['/user-management/auth/login']],
				['label'=>'Logout', 'url'=>['/user-management/auth/logout']],
				['label'=>'Registration', 'url'=>['/user-management/auth/registration']],
				['label'=>'Change own password', 'url'=>['/user-management/auth/change-own-password']],
				['label'=>'Password recovery', 'url'=>['/user-management/auth/password-recovery']],
				['label'=>'E-mail confirmation', 'url'=>['/user-management/auth/confirm-email']],
			],
		],
	],
]);
?>

第一步

从上面的菜单开始，您将只看到两个元素：“登录”和“注销”，因为您没有权限访问其他URL，并且我们使用GhostMenu::widget()来渲染菜单。它仅渲染活动用户可以访问的元素。

同样，GhostNav::widget()和GhostHtml:a()也有相同的功能

1. 以superadmin/superadmin身份登录

2. 转到“权限”并尝试一下

3. 转到“角色”并尝试一下

4. 转到“用户”并尝试一下

5. 放松

用法

您的控制器可能有两个属性，可以使整个控制器或选定的操作对每个人都可以访问

public $freeAccess = true;

或者

public $freeAccessActions = ['first-action', 'another-action'];

以下是有用的辅助器列表。有关详细说明，请参阅相应的函数。

User::hasRole($roles, $superAdminAllowed = true)
User::hasPermission($permission, $superAdminAllowed = true)
User::canRoute($route, $superAdminAllowed = true)

User::assignRole($userId, $roleName)
User::revokeRole($userId, $roleName)

User::getCurrentUser($fromSingleton = true)

角色、权限和路由都具有以下方法

Role::create($name, $description = null, $groupCode = null, $ruleName = null, $data = null)
Role::addChildren($parentName, $childrenNames, $throwException = false)
Role::removeChildren($parentName, $childrenNames)

事件

事件可以通过如下配置文件进行处理

'modules'=>[
	'user-management' => [
		'class' => 'vanterbit\modules\UserManagement\UserManagementModule',
		'on afterRegistration' => function(UserAuthEvent $event) {
			// Here you can do your own stuff like assign roles, send emails and so on
		},
	],
],

支持的完整事件列表可以在UserAuthEvent类中找到

常见问题解答

问题：您有API文档吗？

答案：请参阅此链接 http://opensource.id5.com.br/vanterbit/doc/index.html（归功于 lukBarros）

问题：我希望用户可以通过他们的电子邮件注册和登录！嗯嗯... 他们还应该确认它！

答案：请参阅配置属性$useEmailAsLogin和$emailConfirmationRequired

问题：我想为用户提供具有头像、生日等信息的个人资料。我该怎么做？

答案：个人资料是特定于项目的，所以您将不得不自己实现它们（但您可以在这里找到示例 - https://github.com/vanterbit/user-management/wiki/Profile-and-custom-registration）。以下是无需修改此模块即可执行此操作的方法

1. 创建用于个人资料的表和模型，该模型具有user_id（与“user”表连接）

2. 检查AuthController::actionRegistration()以了解其工作原理（您可以跳过此部分）

3. 定义您的注册布局。检查AuthHelper::layoutHandler()中的示例。现在使用主题更改registration.php文件

4. 定义您自己的 UserManagementModule::$registrationFormClass。在这个类中，您可以执行任何您想做的事情，例如验证自定义表单和保存配置文件

5. 创建您的控制器，用户可以在其中查看配置文件