unisharp/laravel-audit-trail

使用 Laravel 版本 5.1.* 为您的模型保持更改历史

dev-master 2018-03-26 08:12 UTC

This package is auto-updated.

Last update: 2024-09-15 14:40:39 UTC


README

这个软件包是做什么用的?

  • 这个软件包用于 Laravel 5.0/5.1,帮助您将审计日志创建到数据库中。

安装

  1. /config/app.php 中,将以下内容添加到 providers

    Unisharp\AuditTrail\AuditServiceProvider::class,
    

    并以下内容添加到 aliases

    'Audit' => Unisharp\AuditTrail\Facades\Audit::class,
    
  2. 运行 php artisan vendor:publish

  3. 运行 php artisan migrate

用法

所有日志都将记录在 'audit_trails' 表中。

  • 您需要将一个特质添加到您要审计的模型中。

    class User extends Eloquent
    {
      use \Unisharp\AuditTrail\Auditable;
    
      protected $table = 'users';
    
      protected $hidden = ['password'];
    
      protected $fillable = ['username', 'email', 'password'];
    }
  • 在任何您想审计用户日志的地方

    $User->log($action, $comment = null, $subject = null, $subject_id = null)
    Audit::log($action, $comment = null)
    $User->log('log in', 'the action is approved')
    Audit::log('log in', 'the action is approved')
    • $User 是这里的 Eloquent 对象。
    • 第二个和第三个参数是可选的。
    • 您可以将修改的列和列 ID 放入 subjectsubject_id 参数中。
  • 其他用法

    • 您可以通过以下方式获取模型日志

      $User->getLogs();
    • 使用单个用户获取所有日志

      Audit::getByUserId($user_id)
    • 随着时间的推移,日志会过时。您可以通过以下方式清理它们

      $User->cleanLogs()

许可证

此软件包根据 MIT 许可证 许可。