audit-implementation.md

Audit Implementation

Starting from version 4.1.0, support for custom Audit models was added. This lets the user extend implementations other than the traditional Illuminate\Database\Eloquent\Model.

{tip} Audit models must implement the OwenIt\Auditing\Contracts\Audit interface!

MongoDB Audit model example

Start by installing the jenssegers/mongodb package:

composer require jenssegers/mongodb

Implementation:

<?php
namespace App\Models;

use Jenssegers\Mongodb\Eloquent\Model;
use Jenssegers\Mongodb\Relations\MorphTo;

class MongoAudit extends Model implements \OwenIt\Auditing\Contracts\Audit
{
    use \OwenIt\Auditing\Audit;

    /**
     * {@inheritdoc}
     */
    protected $guarded = [];

    /**
     * {@inheritdoc}
     */
    protected $casts = [
        'old_values'   => 'json',
        'new_values'   => 'json',
        'auditable_id' => 'integer',
    ];

    /**
     * {@inheritdoc}
     */
    public function auditable(): MorphTo
    {
        return $this->morphTo();
    }

    /**
     * {@inheritdoc}
     */
    public function user(): MorphTo
    {
        return $this->morphTo();
    }
}

{tip} The bulk of the Audit logic is in the OwenIt\Auditing\Audit trait.

Defining the Audit model

In the config/audit.php file, set the implementation value as the FQCN of the Audit model you wish to use. If the value is missing from the configuration, the audits() relation method of the Auditing trait will default to OwenIt\Auditing\Models\Audit.

Here's how to set the MongoAudit implementation above:

return [
    // ...

    'implementation' => App\Models\MongoAudit::class,

    // ...
];