amgportalapp/activity-log

AMGPortal 的用户活动日志插件。

dev-master 2024-01-19 07:31 UTC

This package is auto-updated.

Last update: 2024-09-19 09:05:08 UTC


README

AMGPortal - 高级 PHP 登录和用户管理系统 的用户活动日志插件

此插件最初是 AMGPortal 的一部分,但从 AMGPortal 4 开始已作为独立的插件提取。

安装

此插件需要 AMGPortal 5.0.0 或更高版本。

通过 Composer 安装

要安装此插件,您需要通过运行以下命令使用 Composer 拉取它

composer require amgportalapp/activity-log

Composer 将为您安装插件及其依赖项。

下一步是将插件注册到 AMGPortalServiceProvider 中的 AMGPortal 插件列表,添加 \AMGPortal\UserActivity\UserActivity::class

protected function plugins()
    {
        return [
            //...
            \AMGPortal\UserActivity\UserActivity::class,
        ];
    }

一旦您的插件被注册,您应该通过运行以下命令发布插件迁移

php artisan vendor:publish --provider="AMGPortal\UserActivity\UserActivity"  --tag="migrations"

然后,在安装的最后一步,您需要运行以下命令以进行所有必要的数据库修改

php artisan migrate
php artisan db:seed --class="ActivityPermissionsSeeder"

此时,插件将完全安装并准备好使用。它已配置为监听来自 AMGPortal 的多数事件并将其放入活动日志。

手动安装

如果您计划对插件进行修改并按需定制,手动添加它会更简单。

为此,您需要从 GitHub 通过点击绿色的 "Clone or download" 按钮,然后在下拉菜单中选择 "Download ZIP" 选项来下载 ZIP 存档。

一旦您在计算机上有了 ZIP 文件,请将其解压缩到 plugins/ActivityLog 文件夹(您需要创建此文件夹,因为它可能不在您的 AMGPortal 安装中)。

下一步是更新位于 AMGPortal 根目录中的主要 composer.json 文件,并在 repositories 数组中添加以下对象

{
    "type": "path",
    "url": "./plugins/ActivityLog"
}

这将告诉 Composer,您的插件位于 /plugins/ActivityLog 目录,并且应该从那里安装。

现在,将以下内容添加到 composer 的 require 部分

"amgportalapp/activity-log": "*"

然后运行 composer update

Composer 现在将从您的本地目录安装插件,而不是从 GitHub 拉取,这意味着您将能够修改插件本身并根据需要定制它。

其余的过程与通过 composer 直接从 GitHub 仓库获取插件相同,因此您需要执行上述所有相同步骤,这简而言之涉及更新 AMGPortalServiceProvider 并运行发布插件静态资产和更新数据库的命令。

仪表板小部件

插件提供了一个用户活动仪表板小部件,对于具有 User 角色的所有用户都可见。

要激活小部件,请将 AMGPortal\UserActivity\Widgets\ActivityWidget::class 添加到 AMGPortalServiceProvider 中的小部件数组

protected function widgets()
{
    return [
       //...
       \AMGPortal\UserActivity\Widgets\ActivityWidget::class,
    ];
}

许可证

此插件是开源软件,根据 MIT 许可证 许可。