README

由 Evan Coury 和 ZF-Commons 团队创建

简介

ZfcUser 是 Laminas 框架 2 的用户注册和认证模块。默认情况下，ZfcUser 与 Laminas\Db 一起工作，但也可以使用其他存储适配器模块（见下文）。ZfcUser 为在您的 ZF2 网站中添加用户认证和注册提供了基础。它设计得非常简单且易于扩展。

更多信息及示例可在 ZfcUser Wiki 上找到。

版本

请使用以下表格确定应使用 ZfcUser 的哪个版本。

存储适配器模块

默认情况下，ZfcUser 内置了对使用 Laminas\Db 来持久化用户的支持。但是，通过安装可选的替代存储适配器模块，您可以利用其他持久化用户的方法。

• ZfcUserDoctrineORM - Doctrine2 ORM
• ZfcUserDoctrineMongoODM - Doctrine2 MongoDB ODM

要求

• Laminas 框架 (最新 master)
• ZfcBase (最新 master)。

特性/目标

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

安装

主要设置

通过克隆项目

1. 通过克隆到 ./vendor/ 安装 ZfcBase ZF2 模块。
2. 将此项目克隆到您的 ./vendor/ 目录。

使用 composer

1. 在您的 composer.json 中添加此项目和 ZfcBase。

   "require": {  
       "zf-commons/zfc-user": "^3.0"  
   }  

2. 现在，通过运行以下命令让 composer 下载 ZfcUser：

   $ php composer.phar update

安装后

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

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

2. 然后导入位于 ./vendor/zf-commons/zfc-user/data/schema.sql（如果您使用Composer安装）或位于 ./vendor/ZfcUser/data/schema.sql 中的SQL模式。

安装后：Doctrine2 ORM

即将推出...

安装后：Doctrine2 MongoDB ODM

即将推出...

安装后：Laminas\Db

1. 如果您在服务管理器配置中还没有有效的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，您应该会进入登录页面。

密码安全

请勿更改密码哈希设置，除非 A) 您已经做了足够的研究并且完全理解您正在更改的内容，并且 B) 您有一个非常具体的理由偏离默认设置。

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

• PHP手册：crypt()函数
• Adrian Schneider的PHP中安全存储密码

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

警告：更改默认密码哈希设置可能会导致严重问题，例如使您的哈希密码更容易受到暴力攻击，或者使哈希变得如此昂贵，以至于登录和注册对用户来说速度太慢，并且给服务器带来了巨大的负担。默认设置提供了两个之间的非常合理的平衡，适用于2013年的计算能力。

选项

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

以下选项可用：

• user_entity_class - 要使用的实体类的名称。如果您想使用自己的实体类而不是默认提供的实体类，则非常有用。默认值为 ZfcUser\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参数，则用户在身份验证成功时将被重定向到指定的URL（如果存在，GET参数将覆盖以下指定的login_redirect_route）。
• login_redirect_route 字符串值，登录成功后用户将被重定向到应用程序中某个路由的名称。
• logout_redirect_route 字符串值，登出后用户将被重定向到应用程序中某个路由的名称。
• password_cost - 应该是一个介于4和31之间的整数。该数字代表用于散列的迭代计数的2的底数对数。默认值为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,
                        ),
                    ),
                ),
            ),
            'ZfcUser\Form\Register' => array(
                'parameters' => array(
                    'captcha_element'=>'recaptcha_element',
                ),
            ),
        ),
    ),
);