koulogliapp/activity-log

Kouloughli 用户活动日志插件。

1.0.3 2020-11-20 14:13 UTC

This package is auto-updated.

Last update: 2024-09-20 23:33:58 UTC


README

Kouloughli - 高级 PHP 登录和用户管理系统 提供用户活动日志插件。

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

安装

此插件需要 Kouloughli 4.0.0 或更高版本。

通过 Composer 安装

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

composer require Kouloughliapp/activity-log

composer 会为您安装插件及其依赖项。

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

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

一旦您的插件注册完成,您应该运行以下命令来发布插件的迁移:

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

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

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

此时插件将完全安装并准备就绪。它配置为监听来自 Kouloughli 的大多数事件并将其放入活动日志。

手动安装

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

为此,您需要通过单击绿色“克隆或下载”按钮并从下拉菜单中选择“下载 ZIP”选项,从 GitHub 下载 ZIP 存档。

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

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

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

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

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

"Kouloughliapp/activity-log": "*"

然后运行 composer update

现在,composer 将从您本地目录安装插件,而不是从 GitHub 拉取,这意味着您将能够修改插件本身并对其进行定制以满足您的需求。

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

仪表板小部件

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

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

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

许可证

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