README

在您的 Laravel 应用中记录活动

spatie/laravel-activitylog 包提供了易于使用的功能来记录您的应用程序用户的操作。它还可以自动记录模型事件。该包将所有活动存储在 activity_log 表中。

以下是一个演示如何使用它的示例

activity()->log('Look, I logged something');

您可以使用 Spatie\Activitylog\Models\Activity 模型检索所有活动。

Activity::all();

以下是一个更高级的示例

activity()
   ->performedOn($anEloquentModel)
   ->causedBy($user)
   ->withProperties(['customProperty' => 'customValue'])
   ->log('Look, I logged something');

$lastLoggedActivity = Activity::all()->last();

$lastLoggedActivity->subject; //returns an instance of an eloquent model
$lastLoggedActivity->causer; //returns an instance of your user model
$lastLoggedActivity->getExtraProperty('customProperty'); //returns 'customValue'
$lastLoggedActivity->description; //returns 'Look, I logged something'

以下是一个关于 事件记录 的示例。

$newsItem->name = 'updated name';
$newsItem->save();

//updating the newsItem will cause the logging of an activity
$activity = Activity::all()->last();

$activity->description; //returns 'updated'
$activity->subject; //returns the instance of NewsItem that was saved

调用 $activity->changes() 将返回此数组

[
   'attributes' => [
        'name' => 'updated name',
        'text' => 'Lorum',
    ],
    'old' => [
        'name' => 'original name',
        'text' => 'Lorum',
    ],
];

支持我们

我们投入了大量资源来创建 最佳开源包。您可以通过 购买我们的付费产品之一 来支持我们。

我们非常感谢您从您的家乡给我们寄来明信片，并提到您正在使用我们的哪些包。您可以在 我们的联系页面 上找到我们的地址。我们将所有收到的明信片发布在我们的 虚拟明信片墙 上。

文档

您可以在 https://spatie.be/docs/laravel-activitylog/introduction 上找到文档。

如果您在使用包时遇到困难？发现了错误？您有没有关于改进活动日志的一般问题或建议？请随时在 GitHub 上 创建一个问题，我们将尽快解决。

安装

您可以通过 composer 安装此包

composer require spatie/laravel-activitylog

该包将自动注册自己。

您可以使用以下命令发布迁移

php artisan vendor:publish --provider="Spatie\Activitylog\ActivitylogServiceProvider" --tag="activitylog-migrations"

注意：默认迁移假设您正在使用整数作为您的模型 ID。如果您正在使用 UUID 或其他格式，请在继续之前调整已发布的迁移中 subject_id 和 causer_id 字段的格式。

发布迁移后，您可以通过运行迁移来创建 activity_log 表

php artisan migrate

您可以选择使用以下命令发布配置文件

php artisan vendor:publish --provider="Spatie\Activitylog\ActivitylogServiceProvider" --tag="activitylog-config"

变更日志

请参阅 CHANGELOG 了解有关最近更改的更多信息。

升级

请参阅 UPGRADING 了解详细信息。

测试

composer test

贡献

请参阅 CONTRIBUTING 了解详细信息。

安全

如果您发现了关于安全的问题，请通过电子邮件 [email protected] 而不是使用问题跟踪器。

鸣谢

• Freek Van der Herten
• Sebastian De Deyne
• Tom Witkowski
• 所有贡献者

特别感谢 Caneco 为 logo 设计，以及 Ahmed Nagi 为 v4 所做的一切工作。

许可证

MIT许可证（MIT）。更多信息请参阅许可证文件。