README

此解决方案易于集成，并对你的项目改动最小：1 个迁移，1 个模型，1 个特质和 1 个外观。

安装

通过 composer 安装此包

composer require elaborate-code/laravel-eloquent-logs

发布迁移

php artisan vendor:publish --tag="eloquent-logs-migrations"

运行迁移

php artisan migrate

发布配置文件（可选）

你可以使用以下命令发布配置文件：

php artisan vendor:publish --tag="eloquent-logs-config"

这是发布配置文件的内容

return [
    'logs_model' => \ElaborateCode\EloquentLogs\Models\EloquentLog::class,
    'logs_table' => 'eloquent_logs',

    'user' => \App\Models\User::class,
];

这允许你在运行迁移之前重命名 logs_table。

使用方法

选择一个你想要记录变更的 Eloquent 模型，并为其添加 HasLogs 特质。

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class ExampleModel extends Model
{
    use \ElaborateCode\EloquentLogs\Concerns\HasLogs;
    // ...
}

添加该特质后，对模型所做的每个变更都将被记录。

重要警告来自 Laravel 文档

当通过 Eloquent 发出 批量更新或删除 查询时，受影响的模型将不会触发 saved、updated、deleting 和 deleted 模型事件。这是因为执行批量更新或删除时，模型实际上从未被检索。

检索日志

你可以使用 eloquentLogs 关系加载模型日志

$example_model->eloquentLogs;

$example_model->load('eloquentLogs');

App\Models\ExampleModel::with('eloquentLogs')->find($id);

并且可以直接查询日志

// latest 5 logs with affected models
ElaborateCode\EloquentLogs\Models\EloquentLog::with('loggable')->latest()->limit(5)->get()

分组查询

默认情况下，每个模型事件都会导致对日志的操作进行一次查询。

$example_model = ExampleModel::create(['name' => 'foo']);

$example_model->update(['name' => 'bar']);

$example_model->delete();

// ⚠️ This will result in 3 queries to insert the 3 events logs into the database

你可以通过使用 CacheEloquentLogQueries 外观来提高日志记录过程

use ElaborateCode\EloquentLogs\Facades\CacheEloquentLogQueries;

CacheEloquentLogQueries::start();

$example_model = ExampleModel::create(['name' => 'foo']);

$example_model->update(['name' => 'bar']);

$example_model->delete();

CacheEloquentLogQueries::execute();

// 👍 This will result in 1 query to insert the 3 events logs into the database

外观还包括你可能不需要使用的方法

// Stops caching and empties the cache without queries execution
CacheEloquentLogQueries::reset();

// Empties the cache but doesn't stop caching
CacheEloquentLogQueries::flushQueries();

// Stops caching until the reuse of start() and doesn't empty the cache
CacheEloquentLogQueries::suspend();

// Returns a boolean
CacheEloquentLogQueries::isCaching();

忽略事件

你可以在模型实例上通过在 YourModel::$loggableOptions['ignore'] 中列出要忽略的事件来指定不记录的事件。

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class ExampleModel extends Model
{
    use \ElaborateCode\EloquentLogs\Concerns\HasLogs;

    public static array $loggableOptions = [
        'ignore' => ['created', 'updated', 'deleted', 'softDeleted', 'forceDeleted', 'restored'],
    ];
    // ...
}

静默 Eloquent 事件 [Laravel 东西]

来自种子文件

namespace Database\Seeders;

use Illuminate\Database\Console\Seeds\WithoutModelEvents;
use Illuminate\Database\Seeder;

class DatabaseSeeder extends Seeder
{
    use WithoutModelEvents; // Add this trait

    public function run(): void
    {
        // Silent eloquent queries ...
    }
}

从你的代码中的任何地方

\Illuminate\Database\Eloquent\Model::unsetEventDispatcher();

// Silent eloquent queries ...

\Illuminate\Database\Eloquent\Model::setEventDispatcher(app(Dispatcher::class));
// ...