README

WhosOnline插件用于CakePHP 3.0（以及CakeManager）可以帮助您监视注册用户。您可以查看他们何时登录、最后出现的时间和更多内容！

您可以看到以下内容

• 最后登录时间戳
• 最后出现时间戳
• 总登录次数
• 总失败登录次数
• 总新密码请求次数

该插件特别为CakeManager插件构建，但也很容易在不使用CakeManager的情况下使用。阅读以下内容以更改当前事件，以便您可以自定义它。

安装

您可以使用composer将此插件安装到您的CakePHP应用程序中。

安装composer包的推荐方法是

composer require cakemanager/cakephp-whosonline

配置

您需要将以下行添加到应用程序的bootstrap.php文件中

Plugin::load('WhosOnline', ['bootstrap' => true, 'routes' => true]);

注意：如果您不使用CakeManager插件，则不需要加载routes。

用法

组件

将以下内容添加到您的AppController中以使用插件回调

$this->loadComponent('WhosOnline.WhosOnline', []);

组件选项

• userId - 会话中用户ID的路径
• userModel - 用户模型。默认 CakeManager.Users
• usermetasModel - 用户元数据模型。默认 WhosOnline.Usermetas
• lastSeen - 如果应该保存最后出现状态，则为布尔值。默认 true
• lastLogin - 如果应该保存最后登录状态，则为布尔值。默认 true
• passedLogins - 如果应该保存通过登录状态，则为布尔值。默认 true
• failedLogins - 如果应该保存失败登录状态，则为布尔值。默认 true
• passwordRequests - 如果应该保存密码请求状态，则为布尔值。默认 true
• events - 用于使用自定义事件的数组。
  • lastSeen - 用户最后出现时的事件。默认 Component.Manager.beforeFilter
  • passwordRequests - 用户请求新密码时的事件。默认 Controller.Users.afterForgotPassword
  • passedLogin - 通过登录时的事件。默认 Controller.Users.afterLogin
  • failedLogin - 失败登录时的事件。默认 Controller.Users.afterInvalidLogin

注意：通过events配置，您可以自定义您自己应用程序的事件！

示例

$this->loadComponent('WhosOnline.WhosOnline', [
  'lastSeen' => true,
  'failedLogins' => false,
  'events.lastSeen' => 'Controller.Users.customAfterLogin'
]);

从现在开始，组件将自动保存所有状态！

监视

如果您想监视用户元数据，请监视菜单项“谁在线”，然后单击它。您将看到最近在线用户及其数据列表。

支持

• CakeManager网站 - CakeManager团队的网站。在这里您可以找到关于我们和我们插件的所有信息。

• Gitter - GitHub的聊天工具，用于讨论问题和新功能。

• GitHub - 当有问题时，请打开新问题！

• CakeManager 文档 - 关于 CakeManager 插件的文档。

贡献

如果您有一个新功能的良好想法，请随时通过 问题 提出，或者开启一个新的问题。我们始终欢迎 pull request。

许可

MIT 许可证 (MIT)

版权所有 (c) 2014 CakeManager by bobmulder

在此特此授予任何获得本软件及其相关文档副本（以下简称“软件”）的人免费使用权，不受限制地处理该软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本，并允许向软件提供的人这样做，但前提是遵守以下条件

上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。

本软件按“原样”提供，不提供任何明示或暗示的保证，包括但不限于适销性、适用于特定目的和不侵犯他人权利的保证。在任何情况下，作者或版权所有者均不对任何索赔、损害或其他责任负责，无论该责任是基于合同、侵权或其他原因，以及与软件或其使用或其他方式相关的软件或使用。