README

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 an activity being logged
$activity = Activity::all()->last();

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

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

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

Spatie 是一家位于比利时安特卫普的网页设计公司。您可以在我们的网站上找到我们所有开源项目的概述 https://spatie.be/opensource。

明信片软件

您可以使用此包（它是 MIT 许可），但如果它进入您的生产环境，我们非常欢迎您从您的家乡给我们寄一张明信片，说明您正在使用我们的哪个包。

我们的地址是：Spatie，Samberstraat 69D，2060 安特卫普，比利时。

所有明信片都发布在我们的网站上 https://spatie.be/en/opensource/postcards。

文档

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

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

如果您发现了有关安全的错误，请通过 freek@spatie.be 发送电子邮件，而不是使用问题跟踪器。

安装

您可以通过 composer 安装此包

composer require spatie/laravel-activitylog

该包将自动注册自己。

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

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

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

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

php artisan migrate

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

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

这是已发布配置文件的内容

return [

    /**
     * When set to false, no activities will be saved to database.
     */
    'enabled' => env('ACTIVITY_LOGGER_ENABLED', true),

    /**
     * When running the clean-command all recording activites older than
     * the number of days specified here will be deleted.
     */
    'delete_records_older_than_days' => 365,


    /**
     * When not specifying a log name when logging activity
     * we'll using this log name.
     */
    'default_log_name' => 'default',


    /**
     * When set to true, the subject returns soft deleted models.
     */
     'subject_returns_soft_deleted_models' => false,
     
     
    /**
     * This model will be used to log activity. The only requirement is that
     * it should be or extend the Spatie\Activitylog\Models\Activity model.
     */
    'activity_model' => \Spatie\Activitylog\Models\Activity::class,     
];

更新日志

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

测试

$ composer test

贡献

有关详细信息，请参阅 CONTRIBUTING。

安全

如果您发现了任何与安全相关的问题，请通过 freek@spatie.be 发送电子邮件，而不是使用问题跟踪器。

鸣谢

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

关于 Spatie

Spatie 是一家位于比利时安特卫普的网页设计公司。您可以在我们的网站上找到我们所有开源项目的概述 https://spatie.be/opensource。

许可

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