README

Yii 2 用户 - 用户认证模块

新版本发布于 2015 年 5 月 7 日

本版本进行了一些小的更新，但不幸的是包含向后不兼容的更改。因此我不得不提高版本号。

升级说明

演示

演示

特性

快速设置 - 直接运行即可看到其功能
易于扩展
使用电子邮件和/或用户名注册
使用电子邮件和/或用户名登录
电子邮件确认（+重发功能）
社交认证（Facebook，Twitter，Google，LinkedIn，Reddit，Vkontakte）
账户页面
- 更新电子邮件、用户名和密码
- 需要当前密码
个人资料页面
- 列出用户自定义字段，例如 full_name
密码恢复
通过 GridView 进行管理员 CRUD

安装

使用您首选的方法安装 Yii 2
通过 composer 安装包 "amnah/yii2-user": "dev-master"
更新配置文件 config/web.php 和 config/db.php

// app/config/web.php
return [
    'components' => [
        // NOTE: in the yii2-advanced-app, the user component should be updated in
        // 'frontend/config/main.php' and/or 'backend/config/main.php' (OR you can add it
        // to 'common/config' if you remove it from frontend/backend)
        'user' => [
            'class' => 'rere\user\components\User',
        ],
        'mailer' => [
            'class' => 'yii\swiftmailer\Mailer',
            'useFileTransport' => true,
            'messageConfig' => [
                'from' => ['admin@website.com' => 'Admin'], // this is needed for sending emails
                'charset' => 'UTF-8',
            ]
        ],
    ],
    'modules' => [
        'user' => [
            'class' => 'rere\user\Module',
            // set custom module properties here ...
        ],
    ],
];
// app/config/db.php
return [
    'class' => 'yii\db\Connection',
    // set up db info
];

运行迁移文件
- php yii migrate --migrationPath=@vendor/amnah/yii2-user/migrations
在浏览器中访问您的应用程序
- https:///pathtoapp/web/user
使用 neo/neo（请更改！）作为管理员登录
根据需要设置模块属性
可选 - 更新主布局中的导航链接 app/views/layouts/main.php

// app/views/layouts/main.php
<?php
'items' => [
    ['label' => 'Home', 'url' => ['/site/index']],
    ['label' => 'About', 'url' => ['/site/about']],
    ['label' => 'Contact', 'url' => ['/site/contact']],
    ['label' => 'User', 'url' => ['/user']],
    Yii::$app->user->isGuest ?
        ['label' => 'Login', 'url' => ['/user/login']] :
        ['label' => 'Logout (' . Yii::$app->user->displayName . ')',
            'url' => ['/user/logout'],
            'linkOptions' => ['data-method' => 'post']],
],

开发说明

如何检查用户权限？

此包包含一个自定义权限系统。每个用户都有一个角色，该角色具有数据库列形式的权限。它应遵循以下格式：can_{permission name}。

例如，默认情况下，role 表有一个名为 can_admin 的列。要检查用户是否可以执行管理员操作

if (!Yii::$app->user->can("admin")) {
    throw new HttpException(403, 'You are not allowed to perform this action.');
}
// --- or ----
$user = User::findOne(1);
if ($user->can("admin")) {
    // do something
};

根据需要添加更多数据库列以设置权限。如果您需要更强大的功能，请查看设置 RBAC。

注意：如果您设置了 authManager 组件用于 RBAC，则 Yii::$app->user->can() 将使用该组件而不是此模块的自定义 role 表。

如何向表单添加验证码？

请查看 dektrium 提供的出色 3 步指南。请注意，验证规则的场景将取决于您项目的需求。

如何添加多语言支持？

// app/config/web.php
return [
    'components' => [
        'i18n' => [
            'translations' => [
                'user' => [
                    'class' => 'yii\i18n\PhpMessageSource',
                    'basePath' => '@app/messages', // example: @app/messages/fr/user.php
                ]
            ],
        ],
    ],
];

如何扩展此包？

您可以直接扩展类。根据您的需要，设置适当的配置属性

// app/config/web.php
'components' => [
    'user' => [
        'class' => 'app\components\MyUser',
        'identityClass' => 'app\models\MyUser',
    ],
],
'modules' => [
    'user' => [
        'class' => 'app\modules\MyModule',
        'controllerMap' => [
            'default' => 'app\controllers\MyDefaultController',
        ],
        'modelClasses'  => [
            'User' => 'app\models\MyUser', // note: don't forget user::identityClass above 
            'Profile' => 'app\models\MyProfile',
        ],
        'emailViewPath' => '@app/mail/user', // example: @app/mail/user/confirmEmail.php
    ],
],

对于视图文件，您可以使用 theme 组件。

// app/config/web.php
'components' => [
    'view' => [
        'theme' => [
            'pathMap' => [
                '@vendor/amnah/yii2-user/views' => '@app/views/user', // example: @app/views/user/default/login.php
            ],
        ],
    ],
],

我需要更多的控制。我能扩展整个包吗？

您总是可以创建分支并按需修改包。

或者，如果您愿意，可以直接通过复制文件将包集成到您的应用中。这样做会使获取更新更困难，但同时也保证了在执行 composer update 后您的应用不会崩溃。

为此，您可以使用辅助命令 CopyController。

将模块添加到您的 config/console.php 以获取对命令的访问权限（注意：这是控制台配置）

// app/config/console.php
'modules' => [
    'user' => [
        'class' => 'rere\user\Module',
    ],
],

使用 php yii user/copy 命令。对于基础应用，您可以调用默认命令而不带任何选项

php yii user/copy --from=@vendor/amnah/yii2-user --to=@app/modules/user --namespace=app\\modules\\user

更新配置以指向您的新包

// app/config/web.php + app/config/console.php
'modules' => [
    'user' => [
        'class' => 'app\modules\user\Module',
    ],
],

或者，您可以手动进行此操作。只需将文件复制到您希望的位置，并更改文件中的命名空间。将 rere\user 替换为 app\modules\user。

待办事项

测试
问题/请求？提交GitHub问题

rere / yii2-user

维护者

详情