vanguardapp/activity-log

Vanguard的用户活动日志插件。

v6.1.0 2024-07-23 08:20 UTC

This package is auto-updated.

Last update: 2024-09-23 08:46:27 UTC


README

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

此插件最初是Vanguard的一部分,但自Vanguard 4版本开始,它已被提取为一个独立的插件。

安装

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

通过Composer安装

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

composer require vanguardapp/activity-log

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

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

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

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

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

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

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

此时,插件将完全安装并准备好使用。它被配置为监听来自Vanguard的大部分事件并将其放入活动日志中。

手动安装

如果您计划修改插件并自定义它以满足您的需求,手动将其添加到项目中会更容易。

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

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

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

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

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

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

"vanguardapp/activity-log": "*"

然后运行composer update

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

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

仪表板小部件

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

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

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

许可证

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