syberisle/laravel-scribe

为模型添加日志的工具

0.0.2 2024-02-25 20:09 UTC

This package is auto-updated.

Last update: 2024-08-25 21:12:00 UTC


README

Latest Version on Packagist GitHub Workflow Status Total Downloads

这是一个有观点的包,它为您的应用程序中的模型提供易于使用的函数来记录诊断信息。这些日志存储在自己的表中。

如果您正在寻找对模型进行自动事件日志记录,请查看spatie/laravel-activitylogowen-it/auditable,因为它们更适合审计日志。

您可以使用它如下

SomeModel::find(1)->log('hi there');

// retrieving model logs
SomeModel::find(1)->logs();
// or
SomeModelLogs::all();

安装

composer install syberisle/laravel-scribe

然后您可以为现有的模型创建日志模型

php artisan make:scribe:model 'App\Models\SomeModel'

注意: 这将自动创建日志模型的迁移,如果您不想自动生成迁移,可以指定 --no-migration

您还需要更新模型以获取 logs()log() 方法。

use SyberIsle\Laravel\Scribe\Model\HasLogs;

class MyModel
{
    use HasLogs;
    
    protected $logModel = MyModelLog::class
    ...
}

UUID 支持

支持迁移使用 UUID

  • 使用 --uuid 将导致迁移和生成的 Log 类通过 HasUuids 特性使用 UUID
  • 使用 --causer-uuid 将导致迁移在创建 causer 列时使用 UUID
  • 主题 ID 将由模型生成器自动检测,并在必要时将 UUID 应用到 subject_id

变更日志

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

贡献

有关详细信息,请参阅 CONTRIBUTING

安全

如果您发现了有关安全性的错误,请通过此存储库的安全标签报告。

许可证

MIT 许可证 (MIT)。有关更多信息,请参阅 许可证文件