eduzz/activity-history-php

此包最新版本(1.0.1)没有提供许可证信息。

Eduzz 活动历史包

1.0.1 2021-02-05 20:52 UTC

This package is not auto-updated.

Last update: 2024-09-24 07:52:40 UTC


README

这个库的目的是以更简单、更有效的方式将系统与 Activity History 服务集成。只需几行代码,就可以发送应用程序日志。

安装(通过 composer)

使用以下命令安装项目包。

    composer require eduzz/activity-history-php

Laravel 项目

完成前面的步骤后,需要在终端执行以下命令,这将生成 config/activityhistory.php 文件。

    php artisan vendor:publish --tag="config"

config/app.php 文件中

// ...
'providers' => [
    // ...
    Eduzz\ActivityHistory\ActivityHistoryServiceProvider::class,
],

Lumen 项目

在 Lumen 中,需要手动复制配置文件。安装 composer 包后,在项目根目录下创建一个名为 config 的文件夹,并将 vendor/eduzz/activity-history-php/src/config/activityhistory.php 文件复制到该文件夹。

bootstrap/app.php 文件中

// ...
$app->configure('activityhistory');
// ...
$app->register(Eduzz\ActivityHistory\ActivityHistoryServiceProvider::class);
// ...

配置 Activity History

config/activityhistory.php 文件中,需要进行两项初始配置

  • secret => 使用 Activity History 的应用程序的 hash。需要联系团队以获取此密钥。

使用 Activity History

要发送日志,只需将 Activity History 注入到您的类中,并设置以下数据

    $this->activityHistory->setUser(
        'application_user_id'
    );

    $this->activityHistory->setUrl('https://example.com');

    $oldData = [
        'name' => 'old name',
        'email' => 'example@example.com'
    ];
    $beforeData = [
        'name' => 'new name',
        'email' => 'example@example.com'
    ];

    $excerpt = [
        'name' => 'new name'
    ];

    $this->activityHistory->publish(
        new ProductUpdate(
            $excerpt,
            $oldData,
            $beforeData
        )
    );