Add withoutAuditing() callback method to temporarily disable auditing for one class

[derekmd]

Summary

Similar to Laravel's Model::withoutEvents() method, allow running Eloquent queries on a given model class inside a callback:

User::withoutAuditing(function () use ($user, $inputs, $additional) {
    // no audit
    $user->update($inputs);

    // this _will_ be audited if the Profile class is Auditable
    $user->profile()->updateOrCreate([], $additional);
});

Only the {class}::withoutAuditing() class will have auditing disabled, so additional model classes need their own call. e.g.,

User::withoutAuditing(fn () => $user->update($inputs));
Profile::withoutAuditing(fn () => $user->profile()->updateOrCreate([], $additional));

---

1. It's wrapped in try / finally to handle restoring auditing after Eloquent possibly throws QueryException.
2. If auditing is already disabled, that setting will be kept. i.e., don't call enableAuditing()

Links

• https://laravel.com/docs/11.x/eloquent#muting-events
• https://github.com/laravel/framework/blob/6c9cbc9ba0437bcfe54609ae0af312feefc7e309/src/Illuminate/Database/Eloquent/Concerns/HasEvents.php#L426-L441
• https://github.com/laravel/framework/blob/e307d111c22066ef614a112664724b4db4956968/src/Illuminate/Support/Traits/Localizable.php#L16 Another example using the same design pattern.

[willpower232]

I don't hate this but I must ask, since this package makes use of Laravel events, could you not make use of ::withoutEvents() or ->saveQuietly() to achieve the same thing?

[derekmd]

You can but that will also prevent other event listeners from being invoked. This method would allow only disabling audit callbacks.

[anteriovieira]

Could someone please update the documentation? You could follow the idea from the Laravel documentation.

https://laravel.com/docs/11.x/eloquent#muting-events

[willpower232]

@derekmd would you like the honours? https://github.com/owen-it/laravel-auditing.com/ perhaps something under the advanced section?

[derekmd]

owen-it/laravel-auditing.com#44

[erikn69]

@derekmd hi, this give me test errors: https://github.com/owen-it/laravel-auditing/actions/runs/9256833548

$result = Article::withoutAuditing(function () {
    $this->assertTrue(Article::$auditingDisabled);
    $this->assertFalse(ArticleExcludes::$auditingDisabled); //here, is true instead of false, why?

[derekmd]

@erikn69: a08c673#diff-a23c87e87a036f61cc6c88f12299ba20cfbbc59b4a825ee48689ee701aeace25L5 merged after I opened this PR changed test stub ArticleExcludes extends Article so the two classes now share the same static $auditingDisabled state.

[erikn69]

Thanks, I already noticed it, #937

[erikn69]

maybe another idea,
globally disable audits on all models within the callback block, maybe it could be done with a second argument