umbacclifford/laravel-activitylog

一个用于监控您多数据库网站或应用程序用户的非常简单的活动记录器

1.12.2-p1 2017-03-26 13:13 UTC

This package is auto-updated.

Last update: 2024-09-14 06:22:13 UTC


README

Latest Version on Packagist Build Status SensioLabsInsight Quality Score StyleCI Total Downloads

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 是一家总部位于比利时安特卫普的网页设计公司。您可以在我们网站上找到所有开源项目的概述 在这里

明信片软件

您可以使用此包(它是 MIT 许可证),但如果它进入了您的生产环境,您需要向我们寄一张来自您家乡的明信片,说明您正在使用我们的哪个包。

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

最好的明信片将发布在我们的网站上。

文档

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

如果您在使用包时遇到困难,发现了错误,或者对改进媒体库有一般性的问题或建议,请随时在 GitHub 上 创建一个问题,我们将尽快处理。

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

安装

您可以通过 composer 安装此包

composer require spatie/laravel-activitylog

接下来,您必须安装服务提供者

// config/app.php
'providers' => [
    ...
    Spatie\Activitylog\ActivitylogServiceProvider::class,
];

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

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 而不是使用问题跟踪器。

鸣谢

关于 Spatie

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

许可证

MIT 许可证 (MIT)。请参阅 许可证文件 了解更多信息。