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 the logging of an activity
$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',
    ],
];

文档

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

如果您在使用包时遇到困难？发现了错误？或者您对改进活动日志有一般性的问题或建议？请随时在 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 [

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

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

    /*
     * If no log name is passed to the activity() helper
     * we use this default log name.
     */
    'default_log_name' => 'default',

    /*
     * You can specify an auth driver here that gets user models.
     * If this is null we'll use the default Laravel auth driver.
     */
    'default_auth_driver' => null,

    /*
     * If set to true, the subject returns soft deleted models.
     */
    'subject_returns_soft_deleted_models' => false,

    /*
     * This model will be used to log activity.
     * It should be implements the Spatie\Activitylog\Contracts\Activity interface
     * and extend Illuminate\Database\Eloquent\Model.
     */
    'activity_model' => \Spatie\Activitylog\Models\Activity::class,

    /*
     * This is the name of the table that will be created by the migration and
     * used by the Activity model shipped with this package.
     */
    'table_name' => 'activity_log',
];

更新日志

有关最近更改的更多信息，请参阅 更新日志。

升级

有关详细信息，请参阅 升级。

测试

composer test

贡献

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

安全性

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

Postcardware

您可以自由使用此包，但如果它进入您的生产环境，我们非常感谢您从家乡给我们寄来一张明信片，说明您正在使用我们的哪些包。

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

我们将发布收到的所有明信片 在我们的公司网站上。

致谢

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

支持我们

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

您的业务是否依赖于我们的贡献？请通过 Patreon 支持我们。所有承诺将专门用于维护和新酷炫功能的人力资源分配。

许可协议

MIT 许可协议（MIT）。更多详细信息请参阅 许可文件。