dynamic/silverstripe-user-invitation

一个用于处理向您的安全网站发送用户邀请的SilverStripe模块。

安装次数: 1,835

依赖者: 0

建议者: 0

安全: 0

星标: 0

关注者: 3

分支: 5

开放性问题: 7

类型:silverstripe-vendormodule

1.0.0-beta3 2024-02-21 16:24 UTC

This package is auto-updated.

Last update: 2024-09-21 17:51:17 UTC


README

此模块添加了向安全网站(例如内部网或外部网)发送用户邀请的功能。

CI codecov

Latest Stable Version Total Downloads Latest Unstable Version License

要求

  • silverstripe/framework ^4

安装

composer require dynamic/silverstripe-user-invitation

许可证

请参阅许可证

邀请用户注册Silverstripe CMS

此模块使得您可以邀请希望在您的网站上注册的用户。用户可以从以下任一方式邀请:

  • 前端表单 自定义操作

  • 或通过CMS中的管理界面。 自定义操作

功能

  • 快速邀请表单(默认情况下,邀请某人只需输入姓名和电子邮件字段)
  • 向收件人发送电子邮件邀请
  • 支持可选的用户组分配(有关如何执行此组选择,请参阅以下内容)
  • 可以通过配置设置邀请过期时间。
  • 应用默认的Silverstripe成员验证。
  • 从CMS管理界面创建和发送邀请

强制分配必需的用户组

在您的mySite/_config/config.yml中放置以下内容

Dynamic\SilverStripe\UserInvitations\Model\UserInvitation:
    force_require_group: true

模板覆盖

要更新基本模板,请使用updateMainTemplates。默认为Page

/**
 * @param array $mainTemplates
 */
public function updateMainTemplates(&$mainTemplates)
{
    array_unshift($mainTemplates, 'InvitationPage');
}

用户创建成功后的重定向

您可以为完成注册后用户重定向的“BackURL”设置一个自定义值。

Dynamic\SilverStripe\UserInvitations\Control\UserController:
    back_url: '/admin/'

请记住设置admin_email(用作发件人)

这将在您的app/_config/email.yml文件中完成

SilverStripe\Control\Email\Email:
    admin_email: #Default email this site sends emails from
        mail@example.com: 'Admin at example.com'

为了方便进行电子邮件测试,请使用:https://mailcatcher.me/

维护者

鸣谢

FSWebWorks/silverstripe-user-invitation分支中获取,以升级到Silverstripe 4 & 5。

错误追踪

错误在存储库的问题部分跟踪。在提交问题之前,请先阅读现有的问题,以确保您的问题具有唯一性。

如果问题看起来像是一个新的错误

  • 创建一个新的问题
  • 描述重现您问题的步骤,以及预期的结果。单元测试、屏幕截图和屏幕录制在这里可能会有所帮助。
  • 尽可能详细地描述您的环境:SilverStripe版本、浏览器、PHP版本、操作系统、任何已安装的SilverStripe模块。

请直接向模块维护者报告安全问题。请不要在错误跟踪器中提交安全问题。

开发和贡献

如果您想为此模块做出贡献,请确保提出拉取请求,并与模块维护者讨论。