README

重要：此仓库已被弃用。

此库已迁移到LM-Commons/LmcUser

LmcUser

基于Evan Coury的ZfcUser和ZF-Commons团队

介绍

LmcUser是Laminas的用户注册和认证模块。LmcUser为在Laminas网站中添加用户认证和注册提供基础。它设计得非常简单且易于扩展。

更多信息和示例请参考原始的ZfcUser Wiki

要求

Laminas (最新主分支)

功能/目标

通过用户名、电子邮件或两者（可以选择放弃用户名概念，仅使用电子邮件）进行认证[已完成]
用户注册[已完成]
表单已保护免受CSRF攻击[已完成]
支持Doctrine2和Laminas\Db[已完成]
强大的事件系统，允许扩展[已完成]
提供ActionController插件和视图辅助函数[已完成]

安装

主要设置

使用Composer

在您的composer.json中添加此项目

"require": {  
    "laminas-commons/lmc-user": "^3.1"  
}

现在运行以下命令以让Composer下载LmcUser
```
$ php composer.phar update
```

安装后

在您的application.config.php文件中启用它。

<?php
return array(
    'modules' => array(
        // ...
        'LmcUser',
    ),
    // ...
);

安装后：Laminas\Db

如果您在服务管理器配置中尚未设置有效的Laminas\Db\Adapter\Adapter，请在./config/autoload/database.local.php中添加以下内容

<?php
return array(
    'db' => array(
        'driver'    => 'PdoMysql',
        'hostname'  => 'changeme',
        'database'  => 'changeme',
        'username'  => 'changeme',
        'password'  => 'changeme',
    ),
    'service_manager' => array(
        'factories' => array(
            'Laminas\Db\Adapter\Adapter' => 'Laminas\Db\Adapter\AdapterServiceFactory',
        ),
    ),
);

导航到http://yourproject/user，您应该会进入登录页面。

从ZfcUser迁移

如果使用Zend DB，请将表名更新为lmc_user

替换所有对ZfcUser的命名空间引用为LmcUser

更新对键zfcuser的引用（小写）为lmcuser

密码安全

请勿更改密码哈希设置的默认值，除非 A) 您已进行了充分的研究并完全了解您要更改的内容，并且 B) 您有非常具体的理由偏离默认设置。

如果您打算更改默认密码哈希设置，请阅读以下内容

可以在任何时候更改密码哈希设置，而不会使现有用户账户无效。现有用户密码将在下次成功登录时自动重新哈希。

警告：更改默认密码哈希设置可能会导致严重问题，例如使您的哈希密码更容易受到暴力攻击，或者使哈希过程变得非常昂贵，导致用户登录和注册速度过慢，并对您的服务器产生很大负担。默认设置提供了两个因素之间非常好的平衡，适合2013年的计算能力。

选项

LmcUser模块有一些选项，允许您快速自定义基本功能。安装LmcUser后，将./vendor/laminas-commons/lmc-user/config/lmcuser.global.php.dist复制到./config/autoload/lmcuser.global.php，并根据需要更改值。

以下选项可用

user_entity_class - 要使用的实体类名称。如果您想使用自己的实体类而不是默认提供的实体类，这很有用。默认为LmcUser\Entity\User。
enable_username - 布尔值，启用注册表单上的用户名字段。默认为false。
auth_identity_fields - 数组值，指定用户在登录时可以使用哪些字段作为'身份'字段。可接受的值：用户名，电子邮件。
enable_display_name - 布尔值，启用注册表单上的显示名称字段。默认值为false。
enable_registration - 布尔值，确定是否允许用户注册。默认值为true。
login_after_registration - 布尔值，在用户成功注册后自动登录用户。默认值为false。
use_registration_form_captcha - 布尔值，确定是否在用户注册表单上使用验证码。默认值为true。（注意，目前这仅使用弱的Laminas\Text\Figlet CAPTCHA，但我有计划使所有Laminas\Captcha适配器都工作。）
login_form_timeout - 整数值，指定登录表单的CSRF安全字段的超时时间（以秒为单位）。默认值为300秒。
user_form_timeout - 整数值，指定注册表单的CSRF安全字段的超时时间（以秒为单位）。默认值为300秒。
use_redirect_parameter_if_present - 布尔值，如果指定了重定向GET参数，当认证成功（如果存在，GET参数将覆盖以下指定的login_redirect_route）时，用户将被重定向到指定的URL。
login_redirect_route 字符串值，应用程序中用户登录成功后将被重定向到的路由的名称。
logout_redirect_route 字符串值，用户注销后将被重定向到的应用程序中路由的名称。
password_cost - 这应该是一个介于4到31之间的整数。该数字代表用于哈希的迭代计数的二进制对数。默认为10（在i5上大约每秒10次哈希）。
enable_user_state - 布尔值，启用用户状态使用。在注册/登录过程中是否应该使用用户的状态？
default_user_state - 整数值，注册时的默认用户状态。用户在注册时应处于哪种状态？
allowed_login_states - 数组值，允许用户登录的状态。当用户尝试登录时，他的/她的状态是否是以下之一？如果想要允许没有状态的用户登录，请包含null。

更改注册验证码元素

注意这些说明目前已过时。

默认情况下，用户注册使用的是 Figlet 验证码引擎。这是因为它是唯一一个不需要API密钥的。可以使用依赖注入（DI）来更换验证码引擎。例如，要切换到 Recaptcha，您需要将其添加到配置文件之一（global.config.php、module.config.php 或 recaptcha.config.php）中。

<?php
// ./config/autoload/recaptcha.config.php
return array(
    'di'=> array(
        'instance'=>array(
            'alias'=>array(
                // OTHER ELEMENTS....
                'recaptcha_element' => 'Laminas\Form\Element\Captcha',
            ),
            'recaptcha_element' => array(
                'parameters' => array(
                    'spec' => 'captcha',
                    'options'=>array(
                        'label'      => '',
                        'required'   => true,
                        'order'      => 500,
                        'captcha'    => array(
                            'captcha' => 'ReCaptcha',
                            'privkey' => RECAPTCHA_PRIVATE_KEY,
                            'pubkey'  => RECAPTCHA_PUBLIC_KEY,
                        ),
                    ),
                ),
            ),
            'LmcUser\Form\Register' => array(
                'parameters' => array(
                    'captcha_element'=>'recaptcha_element',
                ),
            ),
        ),
    ),
);

laminas-commons / lmc-user

维护者

详细信息